International Patient Access
0.1.0 - STU 1 ballot
International Patient Access
0.1.0 - STU 1 ballot
This page is part of the International Patient Access (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
{
"resourceType" : "CapabilityStatement",
"id" : "ipa-server",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">International Patient Access Server CapabilityStatement</h2><ul><li>Official URL: <code>http://hl7.org/fhir/uv/ipa/CapabilityStatement/ipa-server</code></li><li>Official name: <code>InternationalPatientAccessAPI</code></li><li>Implementation Guide Version: 0.8.0</li><li>FHIR Version: 4.0.1</li><li>Supported Formats: <strong>SHALL</strong> support <code>json</code>, <strong>SHOULD</strong> support <code>xml</code></li><li>Supported Patch Formats: <strong>SHOULD</strong> support <code>application/json-patch+json</code></li><li>Published on: Tue Nov 23 00:00:00 CST 2021</li><li>Published by: HL7 International - Patient Care Workgroup</li></ul><div><p>This section describes the basic rules for the International Patient Access server actor that is responsible for providing responses to queries submitted by International Patient Access requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by International Patient Access servers are defined in this CapabilityStatement. International Patient Access 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><h3 id=\"shouldIGs\">SHOULD Support the Following Implementation Guides</h3><ul><li><a href=\"http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch\">http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch</a></li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>The IPA Server <strong>SHALL</strong>:</p>\n<ol>\n<li>Support the IPA Patient resource profile.</li>\n<li>Support at least one additional resource profile from the list of IPA Profiles.</li>\n<li>Implement the RESTful behavior according to the FHIR specification.</li>\n<li>Return the following response classes:\n<ul>\n<li>(Status 400): invalid parameter</li>\n<li>(Status 401/4xx): unauthorized request</li>\n<li>(Status 403): insufficient scope</li>\n<li>(Status 404): unknown resource</li>\n<li>(Status 410): deleted resource.</li>\n</ul>\n</li>\n<li>Support JSON source formats for all IPA interactions.</li>\n<li>Declare a CapabilityStatement identifying the list of profiles, operations, and search parameters supported.</li>\n</ol>\n<p>The IPA Server <strong>SHOULD</strong>:</p>\n<ol>\n<li>Support XML source formats for all IPA interactions.</li>\n<li>Identify the IPA profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</li>\n</ol>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><ol>\n<li>See the <a href=\"security.html\">General Security Considerations</a> section for requirements and recommendations.</li>\n<li>A server <strong>SHALL</strong> reject any unauthorized requests by returning an <code>HTTP 401</code> unauthorized response code.</li>\n</ol>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li><strong>MAY</strong> support the <code>transaction</code> interaction.</li><li><strong>MAY</strong> support the <code>batch</code> interaction.</li><li><strong>MAY</strong> support the <code>search-system</code> interaction.</li><li><strong>MAY</strong> support the <code>history-system</code> interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required or recommended search parameters (if any)</span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#AllergyIntolerance1\">AllergyIntolerance</a></td><td><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>patient, patient+clinical-status</td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#Condition1\">Condition</a></td><td><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>patient, patient+clinical-status, patient+category, patient+category+clinical-status, patient+code, patient+onset-date</td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#DocumentReference1\">DocumentReference</a></td><td><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>_id, patient, patient+category, patient+category+date, patient+type, patient+contenttype, patient+status, patient+type+date, patient+type+period</td><td/><td><code>Provenance:target</code></td><td><code>$docref</code></td></tr><tr><td><a href=\"#Immunization1\">Immunization</a></td><td><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>patient, patient+date, patient+status</td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#Medication1\">Medication</a></td><td><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication</a></td><td>y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#MedicationRequest1\">MedicationRequest</a></td><td><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>category, code, patient, patient+intent, patient+intent+authoredon, patient+intent+status</td><td><code>MedicationRequest:medication</code></td><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#MedicationStatement1\">MedicationStatement</a></td><td><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>subject, subject+status</td><td><code>MedicationRequest:medication</code></td><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#Observation1\">Observation</a></td><td><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation</a><br/><em>Additional supported profiles:</em><br/> <a href=\"http://hl7.org/fhir/StructureDefinition/vitalsigns\">http://hl7.org/fhir/StructureDefinition/vitalsigns</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>patient, patient+category, patient+code, patient+category+date, patient+category+status, patient+code+date</td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#Patient1\">Patient</a></td><td><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>_id, birthdate, family, gender, given, identifier, name, family+gender, birthdate+family, birthdate+name, gender+name</td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#Practitioner1\">Practitioner</a></td><td><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner</a></td><td>y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#PractitionerRole1\">PractitionerRole</a></td><td><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole</a></td><td>y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td><code>PractitionerRole:endpoint</code>, <code>PractitionerRole:practitioner</code></td><td><code>Provenance:target</code></td><td/></tr></tbody></table></div><hr/><div class=\"panel panel-primary\"><div class=\"panel-heading\"><h4 id=\"AllergyIntolerance1\" class=\"panel-title\">AllergyIntolerance</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\">Conformance expectation: <b>SHOULD</b></div><div class=\"col-lg-6\">Reference policy: <code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Base System Profile</span><p><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance</a></p></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Interaction summary</span></div></div><div class=\"row\"><div class=\"col-12\"><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a></td><td><code>reference</code></td></tr></tbody></table></div><div class=\"col-lg-6\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status\">clinical-status</a></td><td><code>reference</code>+<code>token</code></td></tr></tbody></table></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Search Parameter Documentation</span></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>patient</b> of type <code>reference</code></div><div class=\"col-lg-9\"><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></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>clinical-status</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>active | inactive | resolved</p>\n</div></div></div></div></div></div><div class=\"panel panel-primary\"><div class=\"panel-heading\"><h4 id=\"Condition1\" class=\"panel-title\">Condition</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\">Conformance expectation: <b>SHOULD</b></div><div class=\"col-lg-6\">Reference policy: <code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Base System Profile</span><p><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition</a></p></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Interaction summary</span></div></div><div class=\"row\"><div class=\"col-12\"><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a></td><td><code>reference</code></td></tr></tbody></table></div><div class=\"col-lg-6\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/Condition-clinical-status\">clinical-status</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/Condition-category\">category</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/Condition-category\">category</a>+<a href=\"http://hl7.org/fhir/SearchParameter/Condition-clinical-status\">clinical-status</a></td><td><code>reference</code>+<code>token</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/clinical-code\">code</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/Condition-onset-date\">onset-date</a></td><td><code>reference</code>+<code>date</code></td></tr></tbody></table></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Search Parameter Documentation</span></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>code</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>Code for the condition</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>patient</b> of type <code>reference</code></div><div class=\"col-lg-9\"><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></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>clinical-status</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>The clinical status of the condition</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>category</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>The category of the condition</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>onset-date</b> of type <code>date</code></div><div class=\"col-lg-9\"><div><p>Date of onset for the condition</p>\n</div></div></div></div></div></div><div class=\"panel panel-primary\"><div class=\"panel-heading\"><h4 id=\"DocumentReference1\" class=\"panel-title\">DocumentReference</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\">Conformance expectation: <b>SHOULD</b></div><div class=\"col-lg-6\">Reference policy: <code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Base System Profile</span><p><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference</a></p></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Interaction summary</span></div></div><div class=\"row\"><div class=\"col-12\"><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/Resource-id\">_id</a></td><td><code>token</code></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a></td><td><code>reference</code></td></tr></tbody></table></div><div class=\"col-lg-6\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/DocumentReference-category\">category</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/DocumentReference-category\">category</a>+<a href=\"http://hl7.org/fhir/SearchParameter/clinical-date\">date</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/clinical-type\">type</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/DocumentReference-category\">contenttype</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/DocumentReference-status\">status</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/clinical-type\">type</a>+<a href=\"http://hl7.org/fhir/SearchParameter/clinical-date\">date</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/clinical-type\">type</a>+<a href=\"http://hl7.org/fhir/SearchParameter/DocumentReference-period\">period</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr></tbody></table></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Search Parameter Documentation</span></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>date</b> of type <code>date</code></div><div class=\"col-lg-9\"><div><p>When this document reference was created</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>period</b> of type <code>date</code></div><div class=\"col-lg-9\"><div><p>Time of service that is being documented</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>patient</b> of type <code>reference</code></div><div class=\"col-lg-9\"><div><p>The client <strong>SHALL</strong> provide at least an 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></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>category</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>Categorization of document</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>type</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>Kind of document (LOINC if possible)</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>contenttype</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>Mime type of the content, may include charset</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>status</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>current | superseded | entered-in-error</p>\n</div></div></div></div></div></div><div class=\"panel panel-primary\"><div class=\"panel-heading\"><h4 id=\"Immunization1\" class=\"panel-title\">Immunization</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\">Conformance expectation: <b>SHOULD</b></div><div class=\"col-lg-6\">Reference policy: <code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Base System Profile</span><p><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization</a></p></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Interaction summary</span></div></div><div class=\"row\"><div class=\"col-12\"><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a></td><td><code>reference</code></td></tr></tbody></table></div><div class=\"col-lg-6\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/clinical-date\">date</a></td><td><code>reference</code>+<code>date</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/Immunization-status\">status</a></td><td><code>reference</code>+<code>token</code></td></tr></tbody></table></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Search Parameter Documentation</span></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>date</b> of type <code>date</code></div><div class=\"col-lg-9\"><div><p>Vaccination (non)-Administration Date</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>patient</b> of type <code>reference</code></div><div class=\"col-lg-9\"><div><p>The client <strong>SHALL</strong> provide at least an 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></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>status</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>Immunization event status</p>\n</div></div></div></div></div></div><div class=\"panel panel-primary\"><div class=\"panel-heading\"><h4 id=\"Medication1\" class=\"panel-title\">Medication</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\">Conformance expectation: <b>SHOULD</b></div><div class=\"col-lg-6\">Reference policy: <code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>The MedicationStatement and MedicationRequest resources can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationStatement or a MedicationRequest, then the READ and SEARCH Criteria <strong>SHALL</strong> be supported.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Base System Profile</span><p><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication</a></p></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Interaction summary</span></div></div><div class=\"row\"><div class=\"col-12\"><ul><li><strong>SHALL</strong> support <code>read</code>.</li></ul></div></div></div></div></div><div class=\"panel panel-primary\"><div class=\"panel-heading\"><h4 id=\"MedicationRequest1\" class=\"panel-title\">MedicationRequest</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\">Conformance expectation: <b>SHOULD</b></div><div class=\"col-lg-6\">Reference policy: <code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Base System Profile</span><p><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest</a></p></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Interaction summary</span></div></div><div class=\"row\"><div class=\"col-12\"><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a></td><td><code>reference</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/MedicationRequest-category\">category</a></td><td><code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-code\">code</a></td><td><code>token</code></td></tr></tbody></table></div><div class=\"col-lg-6\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/MedicationRequest-intent\">intent</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/MedicationRequest-intent\">intent</a>+<a href=\"http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon\">authoredon</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/MedicationRequest-intent\">intent</a>+<a href=\"http://hl7.org/fhir/SearchParameter/medications-status\">status</a></td><td><code>reference</code>+<code>token</code>+<code>token</code></td></tr></tbody></table></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Search Parameter Documentation</span></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>code</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>Return prescriptions of this medication code</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>authoredon</b> of type <code>date</code></div><div class=\"col-lg-9\"><div><p>Returns prescriptions written on this date</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>patient</b> of type <code>reference</code></div><div class=\"col-lg-9\"><div><p>The client <strong>SHALL</strong> provide at least an 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></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>category</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>Returns prescriptions with different categories</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>intent</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>Return prescriptions with this encounter identifier</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>status</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>Status of the prescription</p>\n</div></div></div></div></div></div><div class=\"panel panel-primary\"><div class=\"panel-heading\"><h4 id=\"MedicationStatement1\" class=\"panel-title\">MedicationStatement</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\">Conformance expectation: <b>SHOULD</b></div><div class=\"col-lg-6\">Reference policy: <code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>The MedicationStatement resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be <a href=\"http://hl7.org/fhir/R4/references.html#contained\">contained</a> or an external resource. The server application <strong>MAY</strong> choose any one way or more than one method, but if an external reference to Medication is used, the server <strong>SHALL</strong> support the _include` parameter for searching this element. The client application must support all methods.</p>\n<p>For example, A server <strong>SHALL</strong> be capable of returning all medications for a patient using one of or both:</p>\n<p><code>GET /MedicationRequest?patient=[id]</code></p>\n<p><code>GET /MedicationRequest?patient=[id]&amp;_include=MedicationRequest:medication</code></p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Base System Profile</span><p><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement</a></p></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Interaction summary</span></div></div><div class=\"row\"><div class=\"col-12\"><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/MedicationStatement-subject\">subject</a></td><td><code>reference</code></td></tr></tbody></table></div><div class=\"col-lg-6\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/MedicationStatement-subject\">subject</a>+<a href=\"http://hl7.org/fhir/SearchParameter/medications-status\">status</a></td><td><code>reference</code>+<code>token</code></td></tr></tbody></table></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Search Parameter Documentation</span></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>subject</b> of type <code>reference</code></div><div class=\"col-lg-9\"><div><p>Return statements that match the given status</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>status</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>Return statements that match the given status</p>\n</div></div></div></div></div></div><div class=\"panel panel-primary\"><div class=\"panel-heading\"><h4 id=\"Observation1\" class=\"panel-title\">Observation</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\">Conformance expectation: <b>SHOULD</b></div><div class=\"col-lg-6\">Reference policy: <code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Base System Profile</span><p><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation</a></p></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/StructureDefinition/vitalsigns\">http://hl7.org/fhir/StructureDefinition/vitalsigns</a></p></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Interaction summary</span></div></div><div class=\"row\"><div class=\"col-12\"><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a></td><td><code>reference</code></td></tr></tbody></table></div><div class=\"col-lg-6\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/Observation-category\">category</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/clinical-code\">code</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/Observation-category\">category</a>+<a href=\"http://hl7.org/fhir/SearchParameter/clinical-date\">date</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/Observation-category\">category</a>+<a href=\"http://hl7.org/fhir/SearchParameter/Observation-status\">status</a></td><td><code>reference</code>+<code>token</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/clinical-patient\">patient</a>+<a href=\"http://hl7.org/fhir/SearchParameter/clinical-code\">code</a>+<a href=\"http://hl7.org/fhir/SearchParameter/clinical-date\">date</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr></tbody></table></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Search Parameter Documentation</span></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>date</b> of type <code>date</code></div><div class=\"col-lg-9\"><div><p>Obtained date/time. If the obtained element is a period, a date that falls in the period</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>code</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>The code of the observation type</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>patient</b> of type <code>reference</code></div><div class=\"col-lg-9\"><div><p>The client <strong>SHALL</strong> provide at least an 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></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>category</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>The classification of the type of observation</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>status</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>The status of the observation</p>\n</div></div></div></div></div></div><div class=\"panel panel-primary\"><div class=\"panel-heading\"><h4 id=\"Patient1\" class=\"panel-title\">Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\">Conformance expectation: <b>SHALL</b></div><div class=\"col-lg-6\">Reference policy: <code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Base System Profile</span><p><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient</a></p></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Interaction summary</span></div></div><div class=\"row\"><div class=\"col-12\"><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/Resource-id\">_id</a></td><td><code>token</code></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/Patient-identifier\">identifier</a></td><td><code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/individual-birthdate\">birthdate</a></td><td><code>date</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/individual-family\">family</a></td><td><code>string</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/individual-gender\">gender</a></td><td><code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/individual-given\">given</a></td><td><code>string</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/Patient-name\">name</a></td><td><code>string</code></td></tr></tbody></table></div><div class=\"col-lg-6\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/individual-family\">family</a>+<a href=\"http://hl7.org/fhir/SearchParameter/individual-gender\">gender</a></td><td><code>string</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/individual-birthdate\">birthdate</a>+<a href=\"http://hl7.org/fhir/SearchParameter/individual-family\">family</a></td><td><code>date</code>+<code>string</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/individual-birthdate\">birthdate</a>+<a href=\"http://hl7.org/fhir/SearchParameter/Patient-name\">name</a></td><td><code>date</code>+<code>string</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/SearchParameter/individual-gender\">gender</a>+<a href=\"http://hl7.org/fhir/SearchParameter/Patient-name\">name</a></td><td><code>token</code>+<code>string</code></td></tr></tbody></table></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Search Parameter Documentation</span></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>identifier</b> of type <code>token</code></div><div class=\"col-lg-9\"><div><p>The client <strong>SHALL</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL NOT</strong> support only code values.</p>\n</div></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>birthdate</b> of type <code>date</code></div><div class=\"col-lg-9\"><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></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>gender</b> of type <code>token</code></div><div class=\"col-lg-9\"><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></div></div><div class=\"row\"><div class=\"col-lg-3\"><b>family</b> of type <code>string</code></div><div class=\"col-lg-9\"><div><p>A server <strong>SHALL</strong> support a value precise to the <em>day</em>.</p>\n</div></div></div></div></div></div><div class=\"panel panel-primary\"><div class=\"panel-heading\"><h4 id=\"Practitioner1\" class=\"panel-title\">Practitioner</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\">Conformance expectation: <b>SHOULD</b></div><div class=\"col-lg-6\">Reference policy: <code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Base System Profile</span><p><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner</a></p></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Interaction summary</span></div></div><div class=\"row\"><div class=\"col-12\"><ul><li><strong>SHALL</strong> support <code>read</code>.</li></ul></div></div></div></div></div><div class=\"panel panel-primary\"><div class=\"panel-heading\"><h4 id=\"PractitionerRole1\" class=\"panel-title\">PractitionerRole</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\">Conformance expectation: <b>SHOULD</b></div><div class=\"col-lg-6\">Reference policy: <code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Base System Profile</span><p><a href=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole</a></p></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Interaction summary</span></div></div><div class=\"row\"><div class=\"col-12\"><ul><li><strong>SHALL</strong> support <code>read</code>.</li></ul></div></div></div></div></div></div>"
},
"url" : "http://hl7.org/fhir/uv/ipa/CapabilityStatement/ipa-server",
"version" : "0.1.0",
"name" : "InternationalPatientAccessAPI",
"title" : "International Patient Access Server CapabilityStatement",
"status" : "draft",
"experimental" : false,
"date" : "2021-11-23T00:00:00.000-06:00",
"publisher" : "HL7 International - Patient Care Workgroup",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "https://www.hl7.org/Special/committees/patientcare"
}
]
}
],
"description" : "This section describes the basic rules for the International Patient Access server actor that is responsible for providing responses to queries submitted by International Patient Access requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by International Patient Access servers are defined in this CapabilityStatement. International Patient Access 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" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"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" : "server",
"documentation" : "The IPA Server **SHALL**:\n\n1. Support the IPA Patient resource profile.\n1. Support at least one additional resource profile from the list of IPA Profiles.\n1. Implement the RESTful behavior according to the FHIR specification.\n1. 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.\n1. Support JSON source formats for all IPA interactions.\n1. Declare a CapabilityStatement identifying the list of profiles, operations, and search parameters supported.\n\nThe IPA Server **SHOULD**:\n\n1. Support XML source formats for all IPA interactions.\n1. Identify the IPA profiles supported as part of the FHIR `meta.profile` attribute for each instance.",
"security" : {
"description" : "1. See the [General Security Considerations](security.html) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."
},
"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",
"profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "clinical-status",
"definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status",
"type" : "token",
"documentation" : "active | inactive | resolved"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "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" : "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" : "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" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "onset-date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Condition",
"profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-category",
"type" : "token",
"documentation" : "The category of the condition"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "clinical-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
"type" : "token",
"documentation" : "The clinical status of the condition"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Code for the condition"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "onset-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-onset-date",
"type" : "date",
"documentation" : "Date of onset for the condition"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "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" : "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" : "contenttype"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "type"
},
{
"url" : "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" : "type"
},
{
"url" : "required",
"valueString" : "period"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "DocumentReference",
"profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"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" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
"type" : "token",
"documentation" : "Categorization of document"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "contenttype",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
"type" : "token",
"documentation" : "Mime type of the content, may include charset"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "When this document reference was created"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "period",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
"type" : "date",
"documentation" : "Time of service that is being documented"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
"type" : "token",
"documentation" : "current | superseded | entered-in-error"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-type",
"type" : "token",
"documentation" : "Kind of document (LOINC if possible)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "docref",
"definition" : "http://hl7.org/fhir/uv/ipa/OperationDefinition/docref",
"documentation" : "A server **SHOULD** be capable of responding to a $docref operation and capable of returning at least a reference to a CDA document, if available. **MAY** provide references to other 'on-demand' and 'stable' documents (or 'delayed/deferred assembly') that meet the query parameters as well. If a context date range is supplied the server ** SHOULD** provide references to any document that falls within the date range If no date range is supplied, then the server **SHALL** provide references to last or current encounter. **SHOULD** document what resources, if any, are returned as included resources\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" : "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",
"profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Vaccination (non)-Administration Date"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-status",
"type" : "token",
"documentation" : "Immunization event status"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Medication",
"profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication",
"documentation" : "The MedicationStatement and MedicationRequest resources can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationStatement or a MedicationRequest, then the READ and SEARCH Criteria **SHALL** be supported.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
}
],
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
]
},
{
"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" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "intent"
},
{
"url" : "required",
"valueString" : "authoredon"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "intent"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "MedicationRequest",
"profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"referencePolicy" : [
"resolves"
],
"searchInclude" : [
"MedicationRequest:medication"
],
"searchRevInclude" : [
"Provenance:target"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-category",
"type" : "token",
"documentation" : "Returns prescriptions with different categories"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Return prescriptions of this medication code"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "authoredon",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon",
"type" : "date",
"documentation" : "Returns prescriptions written on this date"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "intent",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-intent",
"type" : "token",
"documentation" : "Return prescriptions with this encounter identifier"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
"type" : "token",
"documentation" : "Status of the prescription"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "subject"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "MedicationStatement",
"profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement",
"documentation" : "The MedicationStatement resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be [contained](http://hl7.org/fhir/R4/references.html#contained) or an external resource. The server application **MAY** choose any one way or more than one method, but if an external reference to Medication is used, the server **SHALL** support the _include` parameter for searching this element. The client application must support all methods.\r\n\r\n For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:\r\n\r\n `GET /MedicationRequest?patient=[id]`\r\n\r\n `GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication`",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"referencePolicy" : [
"resolves"
],
"searchInclude" : [
"MedicationRequest:medication"
],
"searchRevInclude" : [
"Provenance:target"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
"type" : "token",
"documentation" : "Return statements that match the given status"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationStatement-subject",
"type" : "reference",
"documentation" : "Return statements that match the given status"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "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" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Observation",
"profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation",
"supportedProfile" : [
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-category",
"type" : "token",
"documentation" : "The classification of the type of observation"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "The code of the observation type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Obtained date/time. If the obtained element is a period, a date that falls in the period"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-status",
"type" : "token",
"documentation" : "The status of the observation"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "family"
},
{
"url" : "required",
"valueString" : "gender"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "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" : "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" : "gender"
},
{
"url" : "required",
"valueString" : "name"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Patient",
"profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"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" : "SHOULD"
}
],
"name" : "birthdate",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-birthdate",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *day*.\n\nA server **SHALL** support a value a value precise to the *day*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "family",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-family",
"type" : "string",
"documentation" : "A server **SHALL** support a value precise to the *day*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "gender",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-gender",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "given",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-given",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-identifier",
"type" : "token",
"documentation" : "The client **SHALL** provide both the system and code values.\n\nThe server **SHALL NOT** support only code values."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-name",
"type" : "string"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Practitioner",
"profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
}
],
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "PractitionerRole",
"profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
}
],
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"referencePolicy" : [
"resolves"
],
"searchInclude" : [
"PractitionerRole:endpoint",
"PractitionerRole:practitioner"
],
"searchRevInclude" : [
"Provenance:target"
]
}
],
"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 © 2021+ HL7 International - Patient Care Workgroup. Package hl7.fhir.uv.ipa#0.1.0 based on FHIR 4.0.1. Generated 2021-12-06
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change