US Core Testing Guide - Local Development build (v3.1.1-1). See the Directory of published versions

• Narrative Content
• XML
• JSON

: US Core 3.1.1 Requirements for US Core Responder returning AllergyIntolerance - XML Representation

Raw xml | Download

<Requirements xmlns="http://hl7.org/fhir">
  <id value="us-core-req-allergy-responder"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>These requirements derive from <a href="Requirements-us-core-req-security.html">US Core 3.1.1 Requirements for US Core General Security Considerations</a></p><p>These requirements reference <a href="http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html#allergyintolerance">http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html#allergyintolerance</a></p><p>These requirements apply to the actor <a href="ActorDefinition-us-core-responder.html">US Core Responder</a></p><h2>Statements</h2><table class="grid"><tr><td><b><a href="#us-core-req-allergy-responder-01">us-core-req-allergy-responder-01</a></b></td><td><a href="http://hl7.org/fhir/R5/codesystem-conformance-expectation.html#conformance-expectation-SHALL">SHALL</a></td><td><div><p>The US Core Responder <strong>SHALL</strong> support the AllergyIntolerance read operation and return, if present, a valid and conformant US Core 3.1.1 AllergyIntolerance resource instance.</p>
</div><p>Links:</p><ul><li>Satisfied By: <a href="TestScript-Allergydynamicreadvalidatejson.html">TestScript-Allergydynamicreadvalidatejson.html</a>, <a href="TestScript-Allergydynamicreadvalidatexml.html">TestScript-Allergydynamicreadvalidatexml.html</a></li><li>Source: AEGIS.net, Inc.</li></ul></td></tr><tr><td><b><a href="#us-core-req-allergy-responder-02">us-core-req-allergy-responder-02</a></b></td><td><a href="http://hl7.org/fhir/R5/codesystem-conformance-expectation.html#conformance-expectation-SHALL">SHALL</a></td><td><div><p>The US Core Responder <strong>SHALL</strong> support the AllergyIntolerance search operation and return, if present, valid and conformant US Core 3.1.1 AllergyIntolerance resource instance(s).</p>
</div></td></tr><tr><td><b><a href="#us-core-req-allergy-responder-02-a">us-core-req-allergy-responder-02-a</a></b></td><td><a href="http://hl7.org/fhir/R5/codesystem-conformance-expectation.html#conformance-expectation-SHALL">SHALL</a></td><td><div><p>The US Core Responder <strong>SHALL</strong> support the AllergyIntolerance search parameter 'patient'.</p>
</div><p>Links:</p><ul><li>Parent: <a href="Requirements-us-core-req-allergy-responder.html#us-core-req-allergy-responder-02">US Core 3.1.1 Requirements for US Core Responder returning AllergyIntolerance # us-core-req-allergy-responder-02-a</a></li></ul></td></tr><tr><td><b><a href="#us-core-req-allergy-responder-02-b">us-core-req-allergy-responder-02-b</a></b></td><td><a href="http://hl7.org/fhir/R5/codesystem-conformance-expectation.html#conformance-expectation-MAY">MAY</a></td><td><div><p>The US Core Responder <strong>MAY</strong> support the AllergyIntolerance search parameter 'clinical-status'.</p>
</div><p>Links:</p><ul><li>Parent: <a href="Requirements-us-core-req-allergy-responder.html#us-core-req-allergy-responder-02">US Core 3.1.1 Requirements for US Core Responder returning AllergyIntolerance # us-core-req-allergy-responder-02-b</a></li></ul></td></tr><tr><td><b><a href="#us-core-req-allergy-responder-02-c">us-core-req-allergy-responder-02-c</a></b></td><td><a href="http://hl7.org/fhir/R5/codesystem-conformance-expectation.html#conformance-expectation-SHOULD">SHOULD</a></td><td><div><p>The US Core Responder <strong>SHOULD</strong> support the AllergyIntolerance search parameter combination of 'patient+clinical-status'.</p>
</div><p>Links:</p><ul><li>Parent: <a href="Requirements-us-core-req-allergy-responder.html#us-core-req-allergy-responder-02">US Core 3.1.1 Requirements for US Core Responder returning AllergyIntolerance # us-core-req-allergy-responder-02-c</a></li></ul></td></tr><tr><td><b><a href="#us-core-req-allergy-responder-02-d">us-core-req-allergy-responder-02-d</a></b></td><td><a href="http://hl7.org/fhir/R5/codesystem-conformance-expectation.html#conformance-expectation-SHALL">SHALL</a></td><td><div><p>The US Core Responder <strong>SHALL</strong> support the AllergyIntolerance search parameter _revinclude 'Provenance:target'.</p>
</div><p>Links:</p><ul><li>Parent: <a href="Requirements-us-core-req-allergy-responder.html#us-core-req-allergy-responder-02">US Core 3.1.1 Requirements for US Core Responder returning AllergyIntolerance # us-core-req-allergy-responder-02-d</a></li></ul></td></tr><tr><td><b><a href="#us-core-req-allergy-responder-03">us-core-req-allergy-responder-03</a></b></td><td><a href="http://hl7.org/fhir/R5/codesystem-conformance-expectation.html#conformance-expectation-SHOULD">SHOULD</a></td><td><div><p>The US Core Responder <strong>SHOULD</strong> support the AllergyIntolerance vread and history-instance operations.</p>
</div></td></tr><tr><td><b><a href="#us-core-req-allergy-responder-04">us-core-req-allergy-responder-04</a></b></td><td><a href="http://hl7.org/fhir/R5/codesystem-conformance-expectation.html#conformance-expectation-MAY">MAY</a></td><td><div><p>The US Core Responder <strong>MAY</strong> support the AllergyIntolerance create, update, patch, delete and history-type operations.</p>
</div></td></tr></table></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/core-tg/Requirements/us-core-req-allergy-responder"/>
  <version value="3.1.1-1"/>
  <name value="USCoreReqAllergyResponder"/>
  <title
         value="US Core 3.1.1 Requirements for US Core Responder returning AllergyIntolerance"/>
  <status value="draft"/>
  <date value="2023-08-25"/>
  <publisher value="HL7 FHIR Infrastructure WG"/>
  <contact>
    <name value="HL7 FHIR Infrastructure WG"/>
    <telecom>
      <system value="url"/>
      <value value="https://hl7.org/Special/committees/fiwg"/>
    </telecom>
  </contact>
  <contact>
    <name value="Richard Ettema"/>
    <telecom>
      <system value="email"/>
      <value value="mailto:richard.ettema@aegis.net"/>
    </telecom>
  </contact>
  <description
               value="US Core 3.1.1 Requirements for US Core Responder returning AllergyIntolerance"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <derivedFrom
               value="http://hl7.org/fhir/us/core-tg/Requirements/us-core-req-security"/>
  <reference
             value="http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html#allergyintolerance"/>
  <actor
         value="http://hl7.org/fhir/us/core-tg/ActorDefinition/us-core-responder"/>
  <statement>
    <key value="us-core-req-allergy-responder-01"/>
    <label value="us-core-req-allergy-responder-01"/>
    <conformance value="SHALL"/>
    <requirement
                 value="The US Core Responder **SHALL** support the AllergyIntolerance read operation and return, if present, a valid and conformant US Core 3.1.1 AllergyIntolerance resource instance."/>
    <satisfiedBy value="TestScript-Allergydynamicreadvalidatejson.html"/>
    <satisfiedBy value="TestScript-Allergydynamicreadvalidatexml.html"/>
    <source>
      <display value="AEGIS.net, Inc."/>
    </source>
  </statement>
  <statement>
    <key value="us-core-req-allergy-responder-02"/>
    <label value="us-core-req-allergy-responder-02"/>
    <conformance value="SHALL"/>
    <requirement
                 value="The US Core Responder **SHALL** support the AllergyIntolerance search operation and return, if present, valid and conformant US Core 3.1.1 AllergyIntolerance resource instance(s)."/>
  </statement>
  <statement>
    <key value="us-core-req-allergy-responder-02-a"/>
    <label value="us-core-req-allergy-responder-02-a"/>
    <conformance value="SHALL"/>
    <requirement
                 value="The US Core Responder **SHALL** support the AllergyIntolerance search parameter 'patient'."/>
    <parent value="#us-core-req-allergy-responder-02"/>
  </statement>
  <statement>
    <key value="us-core-req-allergy-responder-02-b"/>
    <label value="us-core-req-allergy-responder-02-b"/>
    <conformance value="MAY"/>
    <requirement
                 value="The US Core Responder **MAY** support the AllergyIntolerance search parameter 'clinical-status'."/>
    <parent value="#us-core-req-allergy-responder-02"/>
  </statement>
  <statement>
    <key value="us-core-req-allergy-responder-02-c"/>
    <label value="us-core-req-allergy-responder-02-c"/>
    <conformance value="SHOULD"/>
    <requirement
                 value="The US Core Responder **SHOULD** support the AllergyIntolerance search parameter combination of 'patient+clinical-status'."/>
    <parent value="#us-core-req-allergy-responder-02"/>
  </statement>
  <statement>
    <key value="us-core-req-allergy-responder-02-d"/>
    <label value="us-core-req-allergy-responder-02-d"/>
    <conformance value="SHALL"/>
    <requirement
                 value="The US Core Responder **SHALL** support the AllergyIntolerance search parameter _revinclude 'Provenance:target'."/>
    <parent value="#us-core-req-allergy-responder-02"/>
  </statement>
  <statement>
    <key value="us-core-req-allergy-responder-03"/>
    <label value="us-core-req-allergy-responder-03"/>
    <conformance value="SHOULD"/>
    <requirement
                 value="The US Core Responder **SHOULD** support the AllergyIntolerance vread and history-instance operations."/>
  </statement>
  <statement>
    <key value="us-core-req-allergy-responder-04"/>
    <label value="us-core-req-allergy-responder-04"/>
    <conformance value="MAY"/>
    <requirement
                 value="The US Core Responder **MAY** support the AllergyIntolerance create, update, patch, delete and history-type operations."/>
  </statement>
</Requirements>