International Patient Access
1.0.0 - STU1
International Patient Access
1.0.0 - STU1
This page is part of the International Patient Access (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Active as of 2022-12-08 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="ipa-client"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">International Patient Access Client CapabilityStatement</h2><ul><li>Implementation Guide Version: 1.0.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: Thu Dec 08 00:00:00 CST 2022</li><li>Published by: HL7 International - Patient Care Work Group</li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id="shallIGs">SHALL Support the Following Implementation Guides</h3><ul><li><a href="http://hl7.org/fhir/smart-app-launch/STU2/">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>client</code></h3></div><div class="panel-body"><div><p>The IPA Client <strong>SHALL</strong>:</p>
<ol>
<li>Support the IPA conformance expectations for the Patient resource profile.</li>
<li>Support the IPA conformance expectations for each IPA resource type they support</li>
<li>Implement the RESTful behavior according to the FHIR specification.</li>
<li>Support JSON source formats for all IPA interactions.</li>
</ol>
<p>The IPA Client <strong>SHOULD</strong>:</p>
<ol>
<li>For the purposes of safety, specify the patient id when searching other resources.</li>
</ol>
</div><div class="lead"><em>Security</em></div><blockquote><div><ol>
<li>See the <a href="security.html">General Security Considerations</a> section for requirements and recommendations.</li>
</ol>
</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, recommended, and some optional 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-1">AllergyIntolerance</a></td><td><a href="StructureDefinition-ipa-allergyintolerance.html">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><td class="text-center"></td><td>clinical-status, patient, patient+clinical-status</td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href="#Condition1-2">Condition</a></td><td><a href="StructureDefinition-ipa-condition.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition</a><br/><em>Additional supported profiles:</em><br/> <a href="StructureDefinition-ipa-problem-list-item.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-problem-list-item</a></td><td>y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td>category, clinical-status, verification-status, code, onset-date, 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-3">DocumentReference</a></td><td><a href="StructureDefinition-ipa-documentreference.html">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><td class="text-center"></td><td>_id, category, contenttype, date, period, status, type, 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-4">Immunization</a></td><td><a href="StructureDefinition-ipa-immunization.html">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><td class="text-center"></td><td>date, status, patient, patient+date, patient+status</td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href="#Medication1-5">Medication</a></td><td><a href="StructureDefinition-ipa-medication.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication</a></td><td>y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href="#MedicationRequest1-6">MedicationRequest</a></td><td><a href="StructureDefinition-ipa-medicationrequest.html">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><td class="text-center"></td><td>category, code, authoredon, intent, status, 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-7">MedicationStatement</a></td><td><a href="StructureDefinition-ipa-medicationstatement.html">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><td class="text-center"></td><td>status, patient, patient+status</td><td><code>MedicationStatement:medication</code></td><td><code>Provenance:target</code></td><td/></tr><tr><td><a href="#Observation1-8">Observation</a></td><td><a href="StructureDefinition-ipa-observation.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation</a><br/><em>Additional supported profiles:</em><br/> <a href="http://hl7.org/fhir/R4/vitalsigns.html">http://hl7.org/fhir/StructureDefinition/vitalsigns</a></td><td>y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td>category, code, date, status, 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-9">Patient</a></td><td><a href="StructureDefinition-ipa-patient.html">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><td class="text-center"></td><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-10">Practitioner</a></td><td><a href="StructureDefinition-ipa-practitioner.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner</a></td><td>y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href="#PractitionerRole1-11">PractitionerRole</a></td><td><a href="StructureDefinition-ipa-practitionerrole.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole</a></td><td>y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></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-default"><div class="panel-heading"><h4 id="AllergyIntolerance1-1" class="panel-title"><span style="float: right;">Resource Conformance: SHOULD</span>AllergyIntolerance</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ipa-allergyintolerance.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>If the client supports the AllergyIntolerance resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the AllergyIntolerance resource.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/allergyintolerance.html#search">patient</a></td><td><code>reference</code></td><td><div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values. The server <strong>SHALL</strong> support both.</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/allergyintolerance.html#search">clinical-status</a></td><td><code>token</code></td><td><div><p>active | inactive | resolved</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"><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/R4/allergyintolerance.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/allergyintolerance.html#search">clinical-status</a></td><td><code>reference</code>+<code>token</code></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Condition1-2" class="panel-title"><span style="float: right;">Resource Conformance: SHOULD</span>Condition</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ipa-condition.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-ipa-problem-list-item.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-problem-list-item</a></p></div><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>If the client supports the Condition resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the Condition resource.</p>
<p>Client applications should be prepared to encounter codes they do not recognize and handle the records
accordingly. Servers SHOULD populate Condition.code.coding.display and/or Condition.code.text so that
clients can always at least display the condition even if they do not know the codes that are used. Clients should be careful making use of the <code>code</code> search parameter given that the codes used vary so much.</p>
<p>Safety Issues:</p>
<ul>
<li>Clients SHALL not treat all conditions as if they are part of the patient's current problem list
<ul>
<li>Note that some Condition resources may not have these status codes - this is usually due to poor record keeping reflected in legacy data</li>
<li>Servers SHOULD avoid leaving these status codes missing</li>
</ul>
</li>
<li>Clients SHALL pay attention to the <code>clinicalStatus</code> and <code>verificationStatus</code> and display and process them correctly * Clients SHALL still work safely when the server does not support all the search parameters listed here.</li>
</ul>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">patient</a></td><td><code>reference</code></td><td><div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values. The server <strong>SHALL</strong> support both.</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">category</a></td><td><code>token</code></td><td><div><p>The category of the condition</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">clinical-status</a></td><td><code>token</code></td><td><div><p>The clinical status of the condition</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">verification-status</a></td><td><code>token</code></td><td><div><p>The verification status of the condition</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">code</a></td><td><code>token</code></td><td><div><p>Code for the condition</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/condition.html#search">onset-date</a></td><td><code>date</code></td><td><div><p>Date of onset for the condition</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"><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/R4/condition.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/condition.html#search">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/R4/condition.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/condition.html#search">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/R4/condition.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/condition.html#search">category</a>+<a href="http://hl7.org/fhir/R4/condition.html#search">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/R4/condition.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/condition.html#search">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/R4/condition.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/condition.html#search">onset-date</a></td><td><code>reference</code>+<code>date</code></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="DocumentReference1-3" class="panel-title"><span style="float: right;">Resource Conformance: SHOULD</span>DocumentReference</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ipa-documentreference.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>If the client supports the DocumentReference resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the DocumentReference resource.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">patient</a></td><td><code>reference</code></td><td><div><p>The client <strong>SHALL</strong> provide at least an id value and <strong>MAY</strong> provide both the Type and id values. The server <strong>SHALL</strong> support both.</p>
</div></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_id</a></td><td><code>token</code></td><td><div></div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">category</a></td><td><code>token</code></td><td><div><p>Categorization of document</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">contenttype</a></td><td><code>token</code></td><td><div><p>Mime type of the content, may include charset</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">date</a></td><td><code>date</code></td><td><div><p>When this document reference was created</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">period</a></td><td><code>date</code></td><td><div><p>Time of service that is being documented</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">status</a></td><td><code>token</code></td><td><div><p>current | superseded | entered-in-error</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/documentreference.html#search">type</a></td><td><code>token</code></td><td><div><p>Kind of document (LOINC if possible)</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"><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/R4/documentreference.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/documentreference.html#search">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/R4/documentreference.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/documentreference.html#search">category</a>+<a href="http://hl7.org/fhir/R4/documentreference.html#search">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/R4/documentreference.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/documentreference.html#search">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/R4/documentreference.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/documentreference.html#search">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/R4/documentreference.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/documentreference.html#search">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/R4/documentreference.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/documentreference.html#search">type</a>+<a href="http://hl7.org/fhir/R4/documentreference.html#search">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/R4/documentreference.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/documentreference.html#search">type</a>+<a href="http://hl7.org/fhir/R4/documentreference.html#search">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">Extended Operations</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href="OperationDefinition-docref.html">$docref</a></td><td><div><p>A client <strong>SHOULD</strong> be capable of transacting a $docref operation and capable of accessing the document using the using the link provided in the <code>DocumentReference.content.attachment.url</code> element.</p>
</div></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Immunization1-4" class="panel-title"><span style="float: right;">Resource Conformance: SHOULD</span>Immunization</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ipa-immunization.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>If the client supports the Immunization resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the Immunization resource.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/immunization.html#search">patient</a></td><td><code>reference</code></td><td><div><p>The client <strong>SHALL</strong> provide at least an id value and <strong>MAY</strong> provide both the Type and id values. The server <strong>SHALL</strong> support both.</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/immunization.html#search">date</a></td><td><code>date</code></td><td><div><p>Vaccination (non)-Administration Date</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/immunization.html#search">status</a></td><td><code>token</code></td><td><div><p>Immunization event status</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"><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/R4/immunization.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/immunization.html#search">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/R4/immunization.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/immunization.html#search">status</a></td><td><code>reference</code>+<code>token</code></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Medication1-5" class="panel-title"><span style="float: right;">Resource Conformance: SHOULD</span>Medication</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ipa-medication.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>If the client supports the the MedicationStatement or MedicationRequest resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the Medication resource.</p>
</div></blockquote></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="MedicationRequest1-6" class="panel-title"><span style="float: right;">Resource Conformance: SHOULD</span>MedicationRequest</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ipa-medicationrequest.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>If the client supports the MedicationRequest resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the MedicationStatement, MedicationRequest and Medication resource.</p>
<p>Clients SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.</p>
<p>The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be <a href="http://hl7.org/fhir/R4/references.html#contained">contained</a> or an external resource. The server application <strong>MAY</strong> choose any one way or more than one method, but if an external reference to Medication is used, the server <strong>SHALL</strong> support the <code>_include</code> parameter for searching this element. The client application <strong>SHALL</strong> support all methods. For example, A server <strong>SHALL</strong> be capable of returning all medications for a patient using one of or both:</p>
<p><code>GET /MedicationStatement?patient=[id]</code></p>
<p><code>GET /MedicationStatement?patient=[id]&_include=MedicationStatement:medication</code></p>
<p>When representing a prescribed medication, servers SHOULD use codings at the level of a clinical drug rather than ingredient or dose form (e.g. "loratadine 10mg oral tablet", rather than a bare ingredient like "loratadine" or a dose form like "loratadine oral tablet").</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html#search">patient</a></td><td><code>reference</code></td><td><div><p>The client <strong>SHALL</strong> provide at least an id value and <strong>MAY</strong> provide both the Type and id values. The server <strong>SHALL</strong> support both.</p>
</div></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html#search">category</a></td><td><code>token</code></td><td><div><p>Returns prescriptions with different categories</p>
</div></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html#search">code</a></td><td><code>token</code></td><td><div><p>Return prescriptions of this medication code</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html#search">authoredon</a></td><td><code>date</code></td><td><div><p>Returns prescriptions written on this date</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html#search">intent</a></td><td><code>token</code></td><td><div><p>Return prescriptions with this encounter identifier</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/medicationrequest.html#search">status</a></td><td><code>token</code></td><td><div><p>Status of the prescription</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"><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/R4/medicationrequest.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/medicationrequest.html#search">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/R4/medicationrequest.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/medicationrequest.html#search">intent</a>+<a href="http://hl7.org/fhir/R4/medicationrequest.html#search">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/R4/medicationrequest.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/medicationrequest.html#search">intent</a>+<a href="http://hl7.org/fhir/R4/medicationrequest.html#search">status</a></td><td><code>reference</code>+<code>token</code>+<code>token</code></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="MedicationStatement1-7" class="panel-title"><span style="float: right;">Resource Conformance: SHOULD</span>MedicationStatement</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ipa-medicationstatement.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>If the client supports the MedicationStatement resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the MedicationStatement, MedicationRequest and Medication resource.</p>
<p>Clients SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.</p>
<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 <code>_include</code> parameter for searching this element. The client application <strong>SHALL</strong> support all methods.For example, A server <strong>SHALL</strong> be capable of returning all medications for a patient using one of or both:</p>
<p><code>GET /MedicationStatement?patient=[id]</code></p>
<p><code>GET/MedicationStatement?patient=[id]&_include=MedicationStatement:medication</code></p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/medicationstatement.html#search">patient</a></td><td><code>reference</code></td><td><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>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/medicationstatement.html#search">status</a></td><td><code>token</code></td><td><div><p>Return statements that match the given status</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"><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/R4/medicationstatement.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/medicationstatement.html#search">status</a></td><td><code>reference</code>+<code>token</code></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Observation1-8" class="panel-title"><span style="float: right;">Resource Conformance: SHOULD</span>Observation</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ipa-observation.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="http://hl7.org/fhir/R4/vitalsigns.html">http://hl7.org/fhir/StructureDefinition/vitalsigns</a></p></div><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>If the client supports the Observation resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the Observation resource.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">patient</a></td><td><code>reference</code></td><td><div><p>The client <strong>SHALL</strong> provide at least an id value and <strong>MAY</strong> provide both the Type and id values. The server <strong>SHALL</strong> support both.</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">category</a></td><td><code>token</code></td><td><div><p>The classification of the type of observation</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">code</a></td><td><code>token</code></td><td><div><p>The code of the observation type</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">date</a></td><td><code>date</code></td><td><div><p>Obtained date/time. If the obtained element is a period, a date that falls in the period</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/observation.html#search">status</a></td><td><code>token</code></td><td><div><p>The status of the observation</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"><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/R4/observation.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/observation.html#search">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/R4/observation.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/observation.html#search">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/R4/observation.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/observation.html#search">category</a>+<a href="http://hl7.org/fhir/R4/observation.html#search">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/R4/observation.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/observation.html#search">category</a>+<a href="http://hl7.org/fhir/R4/observation.html#search">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/R4/observation.html#search">patient</a>+<a href="http://hl7.org/fhir/R4/observation.html#search">code</a>+<a href="http://hl7.org/fhir/R4/observation.html#search">date</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Patient1-9" class="panel-title"><span style="float: right;">Resource Conformance: SHALL</span>Patient</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ipa-patient.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Client applications SHALL be able to access the patient record using the following API call:</p>
<p><code>GET [url]/Patient/[id]</code></p>
<p>Client application MAY use these search parameters that servers are required to support to access the patient record:</p>
<ul>
<li><code>_id</code></li>
<li><code>identifier</code></li>
</ul>
<p>Servers are not required to support any additional search parameters, and clients SHOULD not expect servers to do so.</p>
<p>Additional rules and guidance for supporting <code>Patient.link</code>:</p>
<ul>
<li>The server:
<ul>
<li>SHALL have no more than one Patient with a status of active = "true" <em>from the server being queried</em></li>
<li>MAY include inactive patients on the <em>same server</em></li>
<li>MAY include inactive or active patients from a <em>different server</em></li>
<li>When returning a <a href="http://hl7.org/fhir/bundle.html">search Bundle</a> that contains more than one Patient record for the same patient, the Patient record(s) SHALL use the <code>Patient.link</code> attribute to cross-link the Patient resources.</li>
</ul>
</li>
<li>The client:
<ul>
<li>SHALL be able to follow the link(s) to the other Patient resource(s) and understand the direction of the link (in other words, which Patient is linked to which other Patient)</li>
<li>SHALL understand the <code>Patient.link.type</code> code which defines the type of link between this Patient resource and another Patient resource</li>
<li>SHALL be aware of the linked Patient <code>active</code> flag and that inactive patients may have relevant information</li>
</ul>
</li>
</ul>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_id</a></td><td><code>token</code></td><td><div></div></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/patient.html#search">birthdate</a></td><td><code>date</code></td><td><div><p>A client <strong>SHALL</strong> provide a value precise to the <em>day</em>. A server <strong>SHALL</strong> support a value a value precise to the <em>day</em>.</p>
</div></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/patient.html#search">family</a></td><td><code>string</code></td><td><div></div></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/patient.html#search">gender</a></td><td><code>token</code></td><td><div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values. The server <strong>SHALL</strong> support both.</p>
</div></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/patient.html#search">given</a></td><td><code>string</code></td><td><div></div></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/patient.html#search">identifier</a></td><td><code>token</code></td><td><div><p>The client <strong>SHALL</strong> provide both the system and code values. The server <strong>SHALL NOT</strong> support only code values.</p>
</div></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/patient.html#search">name</a></td><td><code>string</code></td><td><div></div></td></tr></tbody></table></div><div class="col-lg-5"><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/R4/patient.html#search">family</a>+<a href="http://hl7.org/fhir/R4/patient.html#search">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/R4/patient.html#search">birthdate</a>+<a href="http://hl7.org/fhir/R4/patient.html#search">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/R4/patient.html#search">birthdate</a>+<a href="http://hl7.org/fhir/R4/patient.html#search">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/R4/patient.html#search">gender</a>+<a href="http://hl7.org/fhir/R4/patient.html#search">name</a></td><td><code>token</code>+<code>string</code></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Practitioner1-10" class="panel-title"><span style="float: right;">Resource Conformance: SHOULD</span>Practitioner</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ipa-practitioner.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>If the client supports the Practitioner resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the Practitioner resource.</p>
</div></blockquote></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="PractitionerRole1-11" class="panel-title"><span style="float: right;">Resource Conformance: SHOULD</span>PractitionerRole</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ipa-practitionerrole.html">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>If the client supports the PractitionerRole resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the PractitionerRole resource.</p>
</div></blockquote></div></div></div></div></div></div>
</text>
<url value="http://hl7.org/fhir/uv/ipa/CapabilityStatement/ipa-client"/>
<version value="1.0.0"/>
<name value="InternationalPatientAccessClientAPI"/>
<title value="International Patient Access Client CapabilityStatement"/>
<status value="active"/>
<experimental value="false"/>
<date value="2022-12-08"/>
<publisher value="HL7 International - Patient Care Work Group"/>
<contact>
<name value="HL7 International - Patient Care Work Group"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/patientcare"/>
</telecom>
<telecom>
<system value="email"/>
<value value="patientcare@lists.HL7.org"/>
</telecom>
</contact>
<description
value="This CapabilityStatement describes the basic rules for the International Patient Access client actor that initiates a data access request to and retrieves patient data from an IPA Responder. In addition, it lists the client conformance expectations for each resource type documented in IPA. These expectations include supported FHIR profiles, RESTful operations, and search parameters. International Patient Access clients define their capabilities by choosing from this list based on the resource types they need to access."/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
<display value="World"/>
</coding>
</jurisdiction>
<copyright
value="Used by permission of HL7 International all rights reserved Creative Commons License"/>
<kind value="requirements"/>
<fhirVersion value="4.0.1"/>
<format value="json">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</format>
<format value="xml">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</format>
<patchFormat value="application/json-patch+json">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</patchFormat>
<implementationGuide
value="http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</implementationGuide>
<rest>
<mode value="client"/>
<documentation
value="The IPA Client **SHALL**:
1. Support the IPA conformance expectations for the Patient resource profile.
1. Support the IPA conformance expectations for each IPA resource type they support
1. Implement the RESTful behavior according to the FHIR specification.
1. Support JSON source formats for all IPA interactions.
The IPA Client **SHOULD**:
1. For the purposes of safety, specify the patient id when searching other resources."/>
<security>
<description
value="1. See the [General Security Considerations](security.html) section for requirements and recommendations."/>
</security>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="clinical-status"/>
</extension>
</extension>
<type value="AllergyIntolerance"/>
<profile
value="http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="If the client supports the AllergyIntolerance resource, the client **SHALL** support the IPA profile and the conformance expectations for the AllergyIntolerance resource."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="clinical-status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status"/>
<type value="token"/>
<documentation value="active | inactive | resolved"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="clinical-status"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
<extension url="required">
<valueString value="clinical-status"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="code"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="onset-date"/>
</extension>
</extension>
<type value="Condition"/>
<profile
value="http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<supportedProfile
value="http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-problem-list-item">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<documentation
value="If the client supports the Condition resource, the client **SHALL** support the IPA profile and the conformance expectations for the Condition resource.
Client applications should be prepared to encounter codes they do not recognize and handle the records
accordingly. Servers SHOULD populate Condition.code.coding.display and/or Condition.code.text so that
clients can always at least display the condition even if they do not know the codes that are used. Clients should be careful making use of the ```code``` search parameter given that the codes used vary so much.
Safety Issues:
* Clients SHALL not treat all conditions as if they are part of the patient's current problem list
* Note that some Condition resources may not have these status codes - this is usually due to poor record keeping reflected in legacy data
* Servers SHOULD avoid leaving these status codes missing
* Clients SHALL pay attention to the ```clinicalStatus``` and ```verificationStatus``` and display and process them correctly * Clients SHALL still work safely when the server does not support all the search parameters listed here."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="category"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Condition-category"/>
<type value="token"/>
<documentation value="The category of the condition"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="clinical-status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Condition-clinical-status"/>
<type value="token"/>
<documentation value="The clinical status of the condition"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="verification-status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Condition-verification-status"/>
<type value="token"/>
<documentation value="The verification status of the condition"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="code"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-code"/>
<type value="token"/>
<documentation value="Code for the condition"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="onset-date"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Condition-onset-date"/>
<type value="date"/>
<documentation value="Date of onset for the condition"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
<extension url="required">
<valueString value="date"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="type"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="contenttype"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="status"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="type"/>
</extension>
<extension url="required">
<valueString value="date"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="type"/>
</extension>
<extension url="required">
<valueString value="period"/>
</extension>
</extension>
<type value="DocumentReference"/>
<profile
value="http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="If the client supports the DocumentReference resource, the client **SHALL** support the IPA profile and the conformance expectations for the DocumentReference resource."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="category"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-category"/>
<type value="token"/>
<documentation value="Categorization of document"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="contenttype"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-category"/>
<type value="token"/>
<documentation value="Mime type of the content, may include charset"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="date"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-date"/>
<type value="date"/>
<documentation value="When this document reference was created"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="period"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-period"/>
<type value="date"/>
<documentation value="Time of service that is being documented"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-status"/>
<type value="token"/>
<documentation value="current | superseded | entered-in-error"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="type"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-type"/>
<type value="token"/>
<documentation value="Kind of document (LOINC if possible)"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values. The server **SHALL** support both."/>
</searchParam>
<operation>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="docref"/>
<definition
value="http://hl7.org/fhir/uv/ipa/OperationDefinition/docref"/>
<documentation
value="A client **SHOULD** be capable of transacting a $docref operation and capable of accessing the document using the using the link provided in the `DocumentReference.content.attachment.url` element."/>
</operation>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="date"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="status"/>
</extension>
</extension>
<type value="Immunization"/>
<profile
value="http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="If the client supports the Immunization resource, the client **SHALL** support the IPA profile and the conformance expectations for the Immunization resource."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="date"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-date"/>
<type value="date"/>
<documentation value="Vaccination (non)-Administration Date"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Immunization-status"/>
<type value="token"/>
<documentation value="Immunization event status"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values. The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<type value="Medication"/>
<profile
value="http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="If the client supports the the MedicationStatement or MedicationRequest resource, the client **SHALL** support the IPA profile and the conformance expectations for the Medication resource."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="intent"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="intent"/>
</extension>
<extension url="required">
<valueString value="authoredon"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="intent"/>
</extension>
<extension url="required">
<valueString value="status"/>
</extension>
</extension>
<type value="MedicationRequest"/>
<profile
value="http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="If the client supports the MedicationRequest resource, the client **SHALL** support the IPA profile and the conformance expectations for the MedicationStatement, MedicationRequest and Medication resource.
Clients SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.
The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be [contained](http://hl7.org/fhir/R4/references.html#contained) or an external resource. The server application **MAY** choose any one way or more than one method, but if an external reference to Medication is used, the server **SHALL** support the `_include` parameter for searching this element. The client application **SHALL** support all methods. For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:
`GET /MedicationStatement?patient=[id]`
`GET
/MedicationStatement?patient=[id]&_include=MedicationStatement:medication`
When representing a prescribed medication, servers SHOULD use codings at the level of a clinical drug rather than ingredient or dose form (e.g. "loratadine 10mg oral tablet", rather than a bare ingredient like "loratadine" or a dose form like "loratadine oral tablet")."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<referencePolicy value="resolves"/>
<searchInclude value="MedicationRequest:medication"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="category"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MedicationRequest-category"/>
<type value="token"/>
<documentation
value="Returns prescriptions with different categories"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="code"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-code"/>
<type value="token"/>
<documentation value="Return prescriptions of this medication code"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="authoredon"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon"/>
<type value="date"/>
<documentation value="Returns prescriptions written on this date"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="intent"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MedicationRequest-intent"/>
<type value="token"/>
<documentation
value="Return prescriptions with this encounter identifier"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/medications-status"/>
<type value="token"/>
<documentation value="Status of the prescription"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values. The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="status"/>
</extension>
</extension>
<type value="MedicationStatement"/>
<profile
value="http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="If the client supports the MedicationStatement resource, the client **SHALL** support the IPA profile and the conformance expectations for the MedicationStatement, MedicationRequest and Medication resource.
Clients SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.
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 **SHALL** support all methods.For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:
`GET /MedicationStatement?patient=[id]`
`GET/MedicationStatement?patient=[id]&_include=MedicationStatement:medication`"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<referencePolicy value="resolves"/>
<searchInclude value="MedicationStatement:medication"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/medications-status"/>
<type value="token"/>
<documentation value="Return statements that match the given status"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="code"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
<extension url="required">
<valueString value="date"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
<extension url="required">
<valueString value="status"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="code"/>
</extension>
<extension url="required">
<valueString value="date"/>
</extension>
</extension>
<type value="Observation"/>
<profile
value="http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<supportedProfile
value="http://hl7.org/fhir/StructureDefinition/vitalsigns">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<documentation
value="If the client supports the Observation resource, the client **SHALL** support the IPA profile and the conformance expectations for the Observation resource."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="category"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Observation-category"/>
<type value="token"/>
<documentation value="The classification of the type of observation"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="code"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-code"/>
<type value="token"/>
<documentation value="The code of the observation type"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="date"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-date"/>
<type value="date"/>
<documentation
value="Obtained date/time. If the obtained element is a period, a date that falls in the period"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Observation-status"/>
<type value="token"/>
<documentation value="The status of the observation"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values. The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="family"/>
</extension>
<extension url="required">
<valueString value="gender"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="birthdate"/>
</extension>
<extension url="required">
<valueString value="family"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="birthdate"/>
</extension>
<extension url="required">
<valueString value="name"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="gender"/>
</extension>
<extension url="required">
<valueString value="name"/>
</extension>
</extension>
<type value="Patient"/>
<profile
value="http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="Client applications SHALL be able to access the patient record using the following API call:
`GET [url]/Patient/[id]`
Client application MAY use these search parameters that servers are required to support to access the patient record:
- `_id`
- `identifier`
Servers are not required to support any additional search parameters, and clients SHOULD not expect servers to do so.
Additional rules and guidance for supporting `Patient.link`:
- The server:
- SHALL have no more than one Patient with a status of active = "true" *from the server being queried*
- MAY include inactive patients on the *same server*
- MAY include inactive or active patients from a *different server*
- When returning a [search Bundle](http://hl7.org/fhir/bundle.html) that contains more than one Patient record for the same patient, the Patient record(s) SHALL use the `Patient.link` attribute to cross-link the Patient resources.
- The client:
- SHALL be able to follow the link(s) to the other Patient resource(s) and understand the direction of the link (in other words, which Patient is linked to which other Patient)
- SHALL understand the `Patient.link.type` code which defines the type of link between this Patient resource and another Patient resource
- SHALL be aware of the linked Patient `active` flag and that inactive patients may have relevant information"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="birthdate"/>
<definition
value="http://hl7.org/fhir/SearchParameter/individual-birthdate"/>
<type value="date"/>
<documentation
value="A client **SHALL** provide a value precise to the *day*. A server **SHALL** support a value a value precise to the *day*."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="family"/>
<definition
value="http://hl7.org/fhir/SearchParameter/individual-family"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="gender"/>
<definition
value="http://hl7.org/fhir/SearchParameter/individual-gender"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="given"/>
<definition
value="http://hl7.org/fhir/SearchParameter/individual-given"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Patient-identifier"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide both the system and code values. The server **SHALL NOT** support only code values."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="name"/>
<definition value="http://hl7.org/fhir/SearchParameter/Patient-name"/>
<type value="string"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<type value="Practitioner"/>
<profile
value="http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="If the client supports the Practitioner resource, the client **SHALL** support the IPA profile and the conformance expectations for the Practitioner resource."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<type value="PractitionerRole"/>
<profile
value="http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="If the client supports the PractitionerRole resource, the client **SHALL** support the IPA profile and the conformance expectations for the PractitionerRole resource."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<referencePolicy value="resolves"/>
<searchInclude value="PractitionerRole:endpoint"/>
<searchInclude value="PractitionerRole:practitioner"/>
<searchRevInclude value="Provenance:target"/>
</resource>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="transaction"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="batch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-system"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-system"/>
</interaction>
</rest>
</CapabilityStatement>
IG © 2022+ HL7 International - Patient Care Work Group. Package hl7.fhir.uv.ipa#1.0.0 based on FHIR 4.0.1. Generated 2023-03-26
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change