FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/capabilitystatement-ersd-client

Packagehl7.fhir.us.ecr
TypeCapabilityStatement
Idcapabilitystatement-ersd-client
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/ecr/https://build.fhir.org/ig/HL7/case-reporting/CapabilityStatement-capabilitystatement-ersd-client.html
URLhttp://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ersd-client
Version2.1.2
Statusdraft
Date2019-08-23
NameCapabilityStatement_eRSD_Client
TitleCapability Statement eRSD Client
Realmus
Authorityhl7
DescriptionThis section describes the expected capabilities of a client consuming eRSD resources including the Reportable Conditions Trigger Codes (RCTC). #### Conformance requirements for an eRSD Client The eRSD Client **SHALL**: - Support fetching the eRSD Bundle using the supported RESTful interactions. - Support processing PlanDefinition and ValueSet resources that are included in the Bundle. The eRSD Client **MAY**: - Support fetching and reading a Person resource. - Support fetching and reading Subscription resources associated with a Person.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
eicr-document-bundleeICR Document Bundle
ersd-plandefinitioneRSD PlanDefinition
rr-document-bundleRR Document Bundle
us-ph-reporting-bundleUS Public Health Reporting Bundle
us-ph-valueset-libraryUS Public Health ValueSet Library
us-ph-valuesetUS Public Health ValueSet

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement capabilitystatement-ersd-client

Capability Statement eRSD Client

  • Implementation Guide Version: 2.1.2
  • FHIR Version: 4.0.1
  • Supported Formats: application/xml, application/json
  • Supported Patch Formats:
  • Published on: 2019-08-23
  • Published by: HL7 International / Public Health

Note to Implementers: FHIR Capabilities

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.

FHIR RESTful Capabilities

Mode: client

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)

Resource Conformance: supported Bundle

Core FHIR Resource
Bundle
Reference Policy
Interaction summary
  • Supports read.

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.

Resource Conformance: supported ValueSet

Base System Profile
US Public Health ValueSet
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Resource Conformance: supported PlanDefinition

Base System Profile
eRSD PlanDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Resource Conformance: supported Person

Core FHIR Resource
Person
Reference Policy
Interaction summary
  • Supports read.

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.

Resource Conformance: supported Subscription

Core FHIR Resource
Subscription
Reference Policy
Interaction summary
  • Supports read.

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.

Resource Conformance: supported Library

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.


Source

{
  "resourceType": "CapabilityStatement",
  "id": "capabilitystatement-ersd-client",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "pher"
    }
  ],
  "url": "http://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ersd-client",
  "version": "2.1.2",
  "name": "CapabilityStatement_eRSD_Client",
  "title": "Capability Statement eRSD Client",
  "status": "draft",
  "experimental": false,
  "date": "2019-08-23",
  "publisher": "HL7 International / Public Health",
  "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"
            }
          ]
        }
      ]
    }
  ]
}