US Core Testing Guide
3.1.1-1 - ci-build United States of America flag

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

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

Draft as of 2023-08-25

Raw json | Download


{
  "resourceType" : "Requirements",
  "id" : "us-core-req-allergy-responder",
  "text" : {
    "status" : "generated",
    "div" : "<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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></table></div>"
  },
  "url" : "http://hl7.org/fhir/us/core-tg/Requirements/us-core-req-allergy-responder",
  "version" : "3.1.1-1",
  "name" : "USCoreReqAllergyResponder",
  "title" : "US Core 3.1.1 Requirements for US Core Responder returning AllergyIntolerance",
  "status" : "draft",
  "date" : "2023-08-25",
  "publisher" : "HL7 FHIR Infrastructure WG",
  "contact" : [
    {
      "name" : "HL7 FHIR Infrastructure WG",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://hl7.org/Special/committees/fiwg"
        }
      ]
    },
    {
      "name" : "Richard Ettema",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:richard.ettema@aegis.net"
        }
      ]
    }
  ],
  "description" : "US Core 3.1.1 Requirements for US Core Responder returning AllergyIntolerance",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "derivedFrom" : [
    "http://hl7.org/fhir/us/core-tg/Requirements/us-core-req-security"
  ],
  "reference" : [
    "http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html#allergyintolerance"
  ],
  "actor" : [
    "http://hl7.org/fhir/us/core-tg/ActorDefinition/us-core-responder"
  ],
  "statement" : [
    {
      "key" : "us-core-req-allergy-responder-01",
      "label" : "us-core-req-allergy-responder-01",
      "conformance" : [
        "SHALL"
      ],
      "requirement" : "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" : [
        "TestScript-Allergydynamicreadvalidatejson.html",
        "TestScript-Allergydynamicreadvalidatexml.html"
      ],
      "source" : [
        {
          "display" : "AEGIS.net, Inc."
        }
      ]
    },
    {
      "key" : "us-core-req-allergy-responder-02",
      "label" : "us-core-req-allergy-responder-02",
      "conformance" : [
        "SHALL"
      ],
      "requirement" : "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)."
    },
    {
      "key" : "us-core-req-allergy-responder-02-a",
      "label" : "us-core-req-allergy-responder-02-a",
      "conformance" : [
        "SHALL"
      ],
      "requirement" : "The US Core Responder **SHALL** support the AllergyIntolerance search parameter 'patient'.",
      "parent" : "#us-core-req-allergy-responder-02"
    },
    {
      "key" : "us-core-req-allergy-responder-02-b",
      "label" : "us-core-req-allergy-responder-02-b",
      "conformance" : [
        "MAY"
      ],
      "requirement" : "The US Core Responder **MAY** support the AllergyIntolerance search parameter 'clinical-status'.",
      "parent" : "#us-core-req-allergy-responder-02"
    },
    {
      "key" : "us-core-req-allergy-responder-02-c",
      "label" : "us-core-req-allergy-responder-02-c",
      "conformance" : [
        "SHOULD"
      ],
      "requirement" : "The US Core Responder **SHOULD** support the AllergyIntolerance search parameter combination of 'patient+clinical-status'.",
      "parent" : "#us-core-req-allergy-responder-02"
    },
    {
      "key" : "us-core-req-allergy-responder-02-d",
      "label" : "us-core-req-allergy-responder-02-d",
      "conformance" : [
        "SHALL"
      ],
      "requirement" : "The US Core Responder **SHALL** support the AllergyIntolerance search parameter _revinclude 'Provenance:target'.",
      "parent" : "#us-core-req-allergy-responder-02"
    },
    {
      "key" : "us-core-req-allergy-responder-03",
      "label" : "us-core-req-allergy-responder-03",
      "conformance" : [
        "SHOULD"
      ],
      "requirement" : "The US Core Responder **SHOULD** support the AllergyIntolerance vread and history-instance operations."
    },
    {
      "key" : "us-core-req-allergy-responder-04",
      "label" : "us-core-req-allergy-responder-04",
      "conformance" : [
        "MAY"
      ],
      "requirement" : "The US Core Responder **MAY** support the AllergyIntolerance create, update, patch, delete and history-type operations."
    }
  ]
}