PACIO Advance Directive Interoperability Implementation Guide
2.1.0 - STU 2
PACIO Advance Directive Interoperability Implementation Guide
2.1.0 - STU 2
PACIO Advance Directive Interoperability Implementation Guide, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-pacio-adi/ and changes regularly. See the Directory of published versions
| Active as of 2023-11-10 |
{
"resourceType" : "CapabilityStatement",
"id" : "adi",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">ADI CapabilityStatement</h2><ul><li>Implementation Guide Version: 0.0.1</li><li>FHIR Version: 4.0.1</li><li>Supported formats: xml, json</li><li>Published: 2023-11-09</li><li>Published by: HL7 Patient Empowerment Working Group (PE WG)</li></ul><p>This Section describes the expected capabilities of the PACIO Advance Directive Interoperability (ADI) Server actor which is responsible for providing responses to the queries submitted by the ADI Requestors.</p><p>There are two primary vehicles in which Advance Directive Information can be conveyed: DocumentReference and Bundle. Through a DocumentReference, the ADI may be encoded inside directly as content data or referred to through a content reference (pointing to the ADI included in a resource like Binary) or reference a Bundle with the type=document for FHIR encoded data.\nThe resources referred to by the Composition in the document bundle include Patient, Observation, Goal, ServiceRequest, Organization, RelatedPerson, Consent, List, and Provenance.</p><h3 id=\"behavior\">FHIR RESTful Capabilities</h3><p>The ADI Server <strong>SHALL</strong>:</p><ol><li>Support all profiles defined in this Implementation Guide.</li><li>Implement the RESTful behavior according to the FHIR specification.</li><li>Return the following response classes:\n<ul><li>(Status 400): invalid parameter</li><li>(Status 401/4xx): unauthorized request</li><li>(Status 403): insufficient scope</li><li>(Status 404): unknown resource</li><li>(Status 410): deleted resource.</li></ul>\n</li><li>Support json source formats for all ADI interactions.</li><li>Support the searchParameters on each profile individually and in combination.</li></ol><p>The ADI Server <strong>SHOULD</strong>:</p><ol><li>Support xml source formats for all ADI interactions.</li></ol><p id=\"security\"><strong>Security:</strong></p><ol><li>See the <a href=\"security_privacy_consent.html\">Guidance</a> section for requirements and recommendations.</li><li>A server <strong>SHALL</strong> reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found" response code.</li></ol><h3 id=\"resource--details\" class=\"no_toc\">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary of Search Criteria</strong></p><table class=\"grid\"><thead><tr><th>Resource Type</th><th>Supported Profiles</th><th>Supported Searches</th><th>Supported <code>_includes</code></th><th>Supported <code>_revincludes</code></th><th>Supported Operations</th></tr></thead><tbody><tr><td><a href=\"#bundle\">Bundle</a></td><td style=\"white-space:nowrap;\">\n\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t_id, composition, identifier, timestamp, type\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n \n </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#composition\">Composition</a></td><td style=\"white-space:nowrap;\"><a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-Composition-Header.html\">ADI-Composition-Header</a>, \n\n\t\t\t\t\t\t\n\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-PACPComposition.html\">ADI-PACPComposition</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n \n </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#consent\">Consent</a></td><td style=\"white-space:nowrap;\"><a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-HealthcareAgentAuthority.html\">ADI-HealthcareAgentAuthority</a>, \n\n\t\t\t\t\t\t\n\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-ConsentForHealthcareAgent.html\">ADI-ConsentForHealthcareAgent</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n \n </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#documentreference\">DocumentReference</a></td><td style=\"white-space:nowrap;\"><a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-DocumentReference.html\">ADI-DocumentReference</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t_id, authenticator, author, category, contenttype, custodian, date, description, encounter, event, facility, format, identifier, language, location, patient, period, related, relatesto, relation, relationship, security-label, setting, status, subject, type\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n \n </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#goal\">Goal</a></td><td style=\"white-space:nowrap;\"><a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-PersonalGoal.html\">ADI-PersonalGoal</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n \n </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#list\">List</a></td><td style=\"white-space:nowrap;\"><a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-PersonalPrioritiesOrganizer.html\">ADI-PersonalPrioritiesOrganizer</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n \n </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#observation\">Observation</a></td><td style=\"white-space:nowrap;\"><a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-DocumentationObservation.html\">ADI-DocumentationObservation</a>, \n\n\t\t\t\t\t\t\n\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-PersonalInterventionPreference.html\">ADI-PersonalInterventionPreference</a>, \n\n\t\t\t\t\t\t\n\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-OrganDonationObservation.html\">ADI-OrganDonationObservation</a>, \n\n\t\t\t\t\t\t\n\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-AutopsyObservation.html\">ADI-AutopsyObservation</a>, \n\n\t\t\t\t\t\t\n\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-CareExperiencePreference.html\">ADI-CareExperiencePreference</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n \n </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#organization\">Organization</a></td><td style=\"white-space:nowrap;\">\n\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n \n </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#patient\">Patient</a></td><td style=\"white-space:nowrap;\"><a href=\"https://www.hl7.org/fhir/us/core/StructureDefinition-us-core-patient.html\">us-core-patient</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t_id, active, address, address-city, address-country, address-postalcode, address-state, address-use, birthdate, death-date, deceased, email, family, gender, general-practitioner, given, identifier, language, link, name, organization, phone, phonetic, telecom, race, ethnicity\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n \n </td><td>\n\t\t\t\t\t\t\t\n\t<a href=\"https://hl7.org/fhir/R4/patient-operation-match.html\">$match</a>\t\t\t\t\t</td></tr><tr><td><a href=\"#provenance\">Provenance</a></td><td style=\"white-space:nowrap;\"><a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-Provenance.html\">ADI-Provenance</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n \n </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#relatedperson\">RelatedPerson</a></td><td style=\"white-space:nowrap;\"><a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-HealthcareAgent.html\">ADI-HealthcareAgent</a>, \n\n\t\t\t\t\t\t\n\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-Guardian.html\">ADI-Guardian</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n \n </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr></tbody></table><br/><h4 id=\"bundle\" class=\"no_toc\">Bundle</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>create</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>update</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>history-instance</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning a Bundle resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Bundle/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a Bundle resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Bundle/[id]/_history/vid</code>\n\t\t\t\t</li><br/> <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t extensios for this yet. --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_id</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Bundle?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">composition</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Bundle?composition=[composition]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">identifier</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Bundle?identifier=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">timestamp</a></td><td>\n\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Bundle?timestamp=[timestamp]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">type</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Bundle?type=[system]|[code]</code></td></tr></tbody></table><hr/><h4 id=\"composition\" class=\"no_toc\">Composition</h4><p>Conformance Expectation:\t<strong>MAY</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-Composition-Header.html\">ADI-Composition-Header</a>, \n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-PACPComposition.html\">ADI-PACPComposition</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>create</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>update</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>history-instance</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>MAY</strong> be capable of returning a Composition resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Composition/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a Composition resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Composition/[id]/_history/vid</code>\n\t\t\t\t</li><br/> <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t extensios for this yet. --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr/><h4 id=\"consent\" class=\"no_toc\">Consent</h4><p>Conformance Expectation:\t<strong>MAY</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-HealthcareAgentAuthority.html\">ADI-HealthcareAgentAuthority</a>, \n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-ConsentForHealthcareAgent.html\">ADI-ConsentForHealthcareAgent</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>create</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>update</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>history-instance</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>MAY</strong> be capable of returning a Consent resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Consent/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a Consent resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Consent/[id]/_history/vid</code>\n\t\t\t\t</li><br/> <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t extensios for this yet. --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr/><h4 id=\"documentreference\" class=\"no_toc\">DocumentReference</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-DocumentReference.html\">ADI-DocumentReference</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>create</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>update</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>history-instance</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning a DocumentReference resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a DocumentReference resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]/_history/vid</code>\n\t\t\t\t</li><br/> <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t extensios for this yet. --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_id</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?_id=[id]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">authenticator</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?authenticator=[authenticator]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">author</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?author=[author]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">category</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?category=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">contenttype</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?contenttype=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">custodian</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?custodian=[custodian]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">date</a></td><td>\n\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?date=[date]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">description</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?description=[description]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">encounter</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?encounter=[encounter]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">event</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?event=[system]|[code]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">facility</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?facility=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">format</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?format=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">identifier</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?identifier=[system]|[code]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">language</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?language=[system]|[code]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">location</a></td><td>\n\t\t\t\t\t\t\turi\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?location=[uri]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">patient</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?patient=[patient]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">period</a></td><td>\n\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?period=[period]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">related</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?related=[related]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">relatesto</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?relatesto=[relatesto]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">relation</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?relation=[system]|[code]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">relationship</a></td><td>\n\t\t\t\t\t\t\tcomposite\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?relationship=[code]&[value]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">security-label</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?security-label=[system]|[code]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">setting</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?setting=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">status</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?status=[status]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">subject</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?subject=[subject]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">type</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/DocumentReference?type=[system]|[code]</code></td></tr></tbody></table><hr/><h4 id=\"goal\" class=\"no_toc\">Goal</h4><p>Conformance Expectation:\t<strong>MAY</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-PersonalGoal.html\">ADI-PersonalGoal</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>create</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>update</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>history-instance</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>MAY</strong> be capable of returning a Goal resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Goal/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a Goal resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Goal/[id]/_history/vid</code>\n\t\t\t\t</li><br/> <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t extensios for this yet. --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr/><h4 id=\"list\" class=\"no_toc\">List</h4><p>Conformance Expectation:\t<strong>MAY</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-PersonalPrioritiesOrganizer.html\">ADI-PersonalPrioritiesOrganizer</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>create</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>update</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>history-instance</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>MAY</strong> be capable of returning a List resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/List/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a List resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/List/[id]/_history/vid</code>\n\t\t\t\t</li><br/> <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t extensios for this yet. --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr/><h4 id=\"observation\" class=\"no_toc\">Observation</h4><p>Conformance Expectation:\t<strong>MAY</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-DocumentationObservation.html\">ADI-DocumentationObservation</a>, \n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-PersonalInterventionPreference.html\">ADI-PersonalInterventionPreference</a>, \n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-OrganDonationObservation.html\">ADI-OrganDonationObservation</a>, \n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-AutopsyObservation.html\">ADI-AutopsyObservation</a>, \n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-CareExperiencePreference.html\">ADI-CareExperiencePreference</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>create</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>update</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>history-instance</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>MAY</strong> be capable of returning a Observation resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Observation/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a Observation resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Observation/[id]/_history/vid</code>\n\t\t\t\t</li><br/> <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t extensios for this yet. --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr/><h4 id=\"organization\" class=\"no_toc\">Organization</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>create</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>update</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>history-instance</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning a Organization resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Organization/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a Organization resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Organization/[id]/_history/vid</code>\n\t\t\t\t</li><br/> <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t extensios for this yet. --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr/><h4 id=\"patient\" class=\"no_toc\">Patient</h4><p>Conformance Expectation:\t<strong>MAY</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://www.hl7.org/fhir/us/core/StructureDefinition-us-core-patient.html\">us-core-patient</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>create</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>update</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>history-instance</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning a Patient resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Patient/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a Patient resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Patient/[id]/_history/vid</code>\n\t\t\t\t</li><br/> <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t extensios for this yet. --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_id</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?_id=[id]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">active</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?active=[system]|[code]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">address</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?address=[address]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">address-city</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?address-city=[address-city]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">address-country</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?address-country=[address-country]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">address-postalcode</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?address-postalcode=[address-postalcode]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">address-state</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?address-state=[address-state]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">address-use</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?address-use=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-birthdate.html\">birthdate</a></td><td>\n\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?birthdate=[birthdate]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">death-date</a></td><td>\n\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?death-date=[death-date]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">deceased</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?deceased=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">email</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?email=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-family.html\">family</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?family=[family]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-given.html\">gender</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?gender=[system]|[code]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">general-practitioner</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?general-practitioner=[general-practitioner]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-given.html\">given</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?given=[given]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">identifier</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?identifier=[system]|[code]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">language</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?language=[system]|[code]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">link</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?link=[link]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-name.html\">name</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?name=[name]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">organization</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?organization=[organization]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">phone</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?phone=[system]|[code]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">phonetic</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?phonetic=[phonetic]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">telecom</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?telecom=[system]|[code]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"https://www.hl7.org/fhir/us/core/SearchParameter-us-core-race.html\">race</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?race=[system]|[code]</code></td></tr><tr><td><strong>MAY</strong></td><td><a href=\"https://www.hl7.org/fhir/us/core/SearchParameter-us-core-ethnicity.html\">ethnicity</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?ethnicity=[system]|[code]</code></td></tr></tbody></table><br/><br/><strong>Operation: $match</strong><br/><br/><p>The <a href=\"https://hl7.org/fhir/R4/patient-operation-match.html\">$match</a> operation is used to manage patient identification in a context where multiple patient databases exist.To ask an MPI to match a patient, clients use the '$match' operation, which accepts a patient resource which may be only partially complete. The data provided is interpreted as an MPI input and processed by an algorithm of some kind that uses the data to determine the most appropriate matches in the patient set.</p><br/><p>Conformance Expectation:\t<strong>SHOULD</strong></p><p>Documentation:</p><ul><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a unique patient match using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Patient/$match</code>\n\t\t\t\t</li></ul><br/><hr/><h4 id=\"provenance\" class=\"no_toc\">Provenance</h4><p>Conformance Expectation:\t<strong>MAY</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-Provenance.html\">ADI-Provenance</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>create</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>update</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>history-instance</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>MAY</strong> be capable of returning a Provenance resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Provenance/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a Provenance resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Provenance/[id]/_history/vid</code>\n\t\t\t\t</li><br/> <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t extensios for this yet. --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr/><h4 id=\"relatedperson\" class=\"no_toc\">RelatedPerson</h4><p>Conformance Expectation:\t<strong>MAY</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-HealthcareAgent.html\">ADI-HealthcareAgent</a>, \n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-Guardian.html\">ADI-Guardian</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>create</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>update</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>history-instance</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>MAY</strong> be capable of returning a RelatedPerson resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/RelatedPerson/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a RelatedPerson resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/RelatedPerson/[id]/_history/vid</code>\n\t\t\t\t</li><br/> <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t extensions for this yet. --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensions for this yet --></ul><br/></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pe"
}
],
"url" : "http://hl7.org/fhir/us/pacio-adi/CapabilityStatement/adi",
"version" : "2.1.0",
"name" : "PacioAdiCapabilityStatement",
"title" : "ADI CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2023-11-10",
"publisher" : "HL7 International / Patient Empowerment",
"contact" : [
{
"name" : "HL7 International / Patient Empowerment",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientempowerment"
},
{
"system" : "email",
"value" : "patients@lists.HL7.org"
}
]
}
],
"description" : "This Section describes the expected capabilities of the PACIO Advance Directive Interoperability (ADI) Server actor which is responsible for providing responses to the queries submitted by the ADI Requestors. \n\nThere are two primary vehicles in which Advance Directive Information can be conveyed: DocumentReference and Bundle. Through a DocumentReference, the ADI may be encoded inside directly as content data or referred to through a content reference (pointing to the ADI included in a resource like Binary) or reference a Bundle with the type=document for FHIR encoded data.\nThe resources referred to by the Composition in the document bundle include Patient, Observation,Goal, ServiceRequest, Organization, RelatedPerson, Consent, List, and Provenance.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"xml",
"json"
],
"patchFormat" : [
"application/json-patch+json"
],
"implementationGuide" : [
"https://build.fhir.org/ig/HL7/pacio-adi/ImplementationGuide-hl7.fhir.us.pacio-adi"
],
"rest" : [
{
"mode" : "server",
"documentation" : "The ADI Server **SHALL**:\n\n1. Support all profiles defined in this Implementation Guide.\n2. Implement the RESTful behavior according to the FHIR specification.\n3. Return the following response classes:\n - (Status 400): invalid parameter\n - (Status 401/4xx): unauthorized request\n - (Status 403): insufficient scope\n - (Status 404): unknown resource\n - (Status 410): deleted resource.\n4. Support json source formats for all ADI interactions.\n5. Support the searchParameters on each profile individually and in combination.\n\nThe ADI Server **SHOULD**:\n\n1. Support xml source formats for all ADI interactions.",
"security" : {
"description" : "1. See the [Guidance](security_privacy_consent.html) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an HTTP 401 \"Unauthorized\", HTTP 403 \"Forbidden\", or HTTP 404 \"Not Found\" response code."
},
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Bundle",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"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" : "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" : "SHALL"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
}
],
"referencePolicy" : [
"resolves"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "composition",
"definition" : "http://hl7.org/fhir/SearchParameter/Bundle-composition",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Bundle-identifier",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "timestamp",
"definition" : "http://hl7.org/fhir/SearchParameter/Bundle-timestamp",
"type" : "date"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Bundle-type",
"type" : "token"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"type" : "Composition",
"supportedProfile" : [
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-Composition-Header.html",
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-PACPComposition.html"
],
"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" : "MAY"
}
],
"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" : "SHOULD"
}
],
"code" : "history-instance"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Consent",
"supportedProfile" : [
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-HealthcareAgentAuthority.html",
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-ConsentForHealthcareAgent.html"
],
"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" : "MAY"
}
],
"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" : "SHOULD"
}
],
"code" : "history-instance"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "DocumentReference",
"supportedProfile" : [
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-DocumentReference.html"
],
"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" : "SHALL"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
}
],
"referencePolicy" : [
"resolves"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "authenticator",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-authenticator",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "author",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-author",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "contenttype",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "custodian",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-custodian",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-date",
"type" : "date"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-description",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "event",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-event",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "facility",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "format",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "language",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-language",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-location",
"type" : "uri"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "period",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
"type" : "date"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "related",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-related",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "relatesto",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-relatesto",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "relation",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-relation",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "security-label",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-security-label",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "setting",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-setting",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-subject",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-type",
"type" : "token"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"type" : "Goal",
"supportedProfile" : [
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-PersonalGoal.html"
],
"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" : "MAY"
}
],
"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" : "SHOULD"
}
],
"code" : "history-instance"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"type" : "List",
"supportedProfile" : [
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-PersonalPrioritiesOrganizer.html"
],
"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" : "MAY"
}
],
"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" : "SHOULD"
}
],
"code" : "history-instance"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"type" : "Observation",
"supportedProfile" : [
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-DocumentationObservation.html",
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-PersonalInterventionPreference.html",
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-OrganDonationObservation.html",
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-AutopsyObservation.html",
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-CareExperiencePreference.html"
],
"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" : "MAY"
}
],
"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" : "SHOULD"
}
],
"code" : "history-instance"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Organization",
"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" : "SHALL"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"type" : "Patient",
"supportedProfile" : [
"https://www.hl7.org/fhir/us/core/StructureDefinition-us-core-patient.html"
],
"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" : "SHALL"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
}
],
"referencePolicy" : [
"resolves"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id",
"type" : "token",
"documentation" : "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-id.html"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "active",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-active",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "address",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "address-city",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-city",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "address-country",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-country",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "address-postalcode",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-postalcode",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "address-state",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-state",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "address-use",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-use",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "birthdate",
"definition" : "https://build.fhir.org/ig/HL7/pacio-adi/SearchParameter/patient-birthdate",
"type" : "date",
"documentation" : "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-birthdate.html"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "death-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-death-date",
"type" : "date"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "deceased",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-deceased",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "email",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-email",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "family",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family",
"type" : "string",
"documentation" : "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-family.html"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "gender",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender",
"type" : "token",
"documentation" : "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-given.html"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "general-practitioner",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-general-practitioner",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "given",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given",
"type" : "string",
"documentation" : "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-given.html"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier",
"type" : "token",
"documentation" : "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-identifier.html"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "language",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-language",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "link",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-link",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name",
"type" : "string",
"documentation" : "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-name.html"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "organization",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-organization",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "phone",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-phone",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "phonetic",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-phonetic",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "telecom",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-telecom",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "race",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-race",
"type" : "token",
"documentation" : "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-race.html"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "ethnicity",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-ethnicity",
"type" : "token",
"documentation" : "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-ethnicity.html"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"type" : "Provenance",
"supportedProfile" : [
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-Provenance.html"
],
"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" : "MAY"
}
],
"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" : "SHOULD"
}
],
"code" : "history-instance"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"type" : "RelatedPerson",
"supportedProfile" : [
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-HealthcareAgent.html",
"https://hl7.org/fhir/us/pacio-adi/StructureDefinition-ADI-Guardian.html"
],
"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" : "MAY"
}
],
"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" : "SHOULD"
}
],
"code" : "history-instance"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"type" : "OperationDefinition",
"profile" : "https://hl7.org/fhir/R4/patient-operation-match.html",
"operation" : [
{
"name" : "$match",
"definition" : "https://hl7.org/fhir/R4/patient-operation-match.html",
"documentation" : "$match is a service used to manage patient identification in a context where multiple patient databases exist.To ask an MPI to match a patient, clients use the '$match' operation, which accepts a patient resource which may be only partially complete. The data provided is interpreted as an MPI input and processed by an algorithm of some kind that uses the data to determine the most appropriate matches in the patient set."
}
]
}
]
}
]
}
IG © 2021+ HL7 International / Patient Empowerment. Package hl7.fhir.us.pacio-adi#2.1.0 based on FHIR 4.0.1. Generated 2024-11-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change