HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.0.0 - STU 2

This page is part of the electronic Case Reporting (eCR) (v2.0.0: STU 2 on FHIR R4) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

: eRSD Client CapabilityStatement - JSON Representation

Raw json | Download


{
  "resourceType" : "CapabilityStatement",
  "id" : "capabilitystatement-ersd-client",
  "meta" : {
    "versionId" : "13",
    "lastUpdated" : "2021-08-19T08:19:41.534+00:00",
    "source" : "#udNCEai5UlqF43SD"
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>CapabilityStatement_eRSD_Client</h2><div><p>This section describes the expected capabilities of a client consuming eRSD resources including the Reportable Conditions Trigger Codes (RCTC).</p>\n<h4>Conformance requirements for an eRSD Client</h4>\n<p>The eRSD Client <strong>SHALL</strong>:</p>\n<ul>\n<li>Support fetching the eRSD Bundle using the supported RESTful interactions.</li>\n<li>Support processing PlanDefinition and ValueSet resources that are included in the Bundle.</li>\n</ul>\n<p>The eRSD Client <strong>MAY</strong>:</p>\n<ul>\n<li>Support fetching and reading a Person resource.</li>\n<li>Support fetching and reading Subscription resources associated with a Person.</li>\n</ul>\n</div><table><tr><td>Mode</td><td>CLIENT</td></tr><tr><td>Description</td><td/></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title=\"GET a resource (read interaction)\">Read</b></th><th><b title=\"GET all set of resources of the type (search interaction)\">Search</b></th><th><b title=\"PUT a new resource version (update interaction)\">Update</b></th><th><b title=\"POST a new resource (create interaction)\">Create</b></th></tr><tr><td>Bundle</td><td>Supported profiles:<br/>  <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle\">http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle</a><br/>  <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-document-bundle\">http://hl7.org/fhir/us/ecr/StructureDefinition/rr-document-bundle</a><br/>  <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-reporting-bundle\">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-reporting-bundle</a></td><td>y</td><td></td><td></td><td></td></tr><tr><td>ValueSet</td><td><a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset\">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset</a></td><td>y</td><td></td><td></td><td></td></tr><tr><td>PlanDefinition</td><td><a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition\">http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition</a></td><td>y</td><td></td><td></td><td></td></tr><tr><td>Person</td><td> </td><td>y</td><td></td><td></td><td></td></tr><tr><td>Subscription</td><td> </td><td>y</td><td></td><td></td><td></td></tr><tr><td>Library</td><td><a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset-library\">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset-library</a></td><td>y</td><td></td><td></td><td></td></tr></table></div>"
  },
  "url" : "http://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ersd-client",
  "version" : "2.0.0",
  "name" : "CapabilityStatement_eRSD_Client",
  "title" : "Capability Statement eRSD Client",
  "status" : "draft",
  "experimental" : false,
  "date" : "2019-08-23",
  "publisher" : "HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)",
  "contact" : [
    {
      "name" : "HL7 International - Public Health",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/pher"
        }
      ]
    }
  ],
  "description" : "This section describes the expected capabilities of a client consuming eRSD resources including the Reportable Conditions Trigger Codes (RCTC).\n\n#### Conformance requirements for an eRSD Client\n\nThe eRSD Client **SHALL**:\n\n- Support fetching the eRSD Bundle using the supported RESTful interactions.\n- Support processing PlanDefinition and ValueSet resources that are included in the Bundle.\n\nThe eRSD Client **MAY**:\n\n- Support fetching and reading a Person resource.\n- Support fetching and reading Subscription resources associated with a Person.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ],
      "text" : "United States of America"
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "application/xml",
    "application/json"
  ],
  "rest" : [
    {
      "mode" : "client",
      "resource" : [
        {
          "type" : "Bundle",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle",
            "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-document-bundle",
            "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-reporting-bundle"
          ],
          "documentation" : "The Bundle represents the artifacts that are to be distributed to subscribers. The Bundle contains the information necessary for implementers to update their systems. The Bundle typically includes PlanDefinition and ValueSet resources. The Bundle may also contain a message from the administrator that indicates the severity of the update.",
          "interaction" : [
            {
              "code" : "read"
            }
          ]
        },
        {
          "type" : "ValueSet",
          "profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset",
          "interaction" : [
            {
              "code" : "read"
            }
          ]
        },
        {
          "type" : "PlanDefinition",
          "profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition",
          "interaction" : [
            {
              "code" : "read"
            }
          ]
        },
        {
          "type" : "Person",
          "documentation" : "The Person resource is used by the eRSD server to associate one or more Subscriptions to an individual. The Person contains references to the Subscriptions associated with the Person.",
          "interaction" : [
            {
              "code" : "read"
            }
          ]
        },
        {
          "type" : "Subscription",
          "documentation" : "A Subscription is used to notify a Person using the specified channel (email, rest-hook or email-based SMS) that a Bundle has been updated on the FHIR Server.",
          "interaction" : [
            {
              "code" : "read"
            }
          ]
        },
        {
          "type" : "Library",
          "profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset-library",
          "interaction" : [
            {
              "code" : "read"
            }
          ]
        }
      ]
    }
  ]
}