HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.2 - STU 2 United States of America flag

This page is part of the electronic Case Reporting (eCR) (v2.1.2: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

CapabilityStatement: eRSD Client CapabilityStatement

Official URL: http://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ersd-client Version: 2.1.2
Draft as of 2019-08-23 Computable Name: CapabilityStatement_eRSD_Client
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.13.2

This 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.

Raw OpenAPI-Swagger Definition file | Download

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 TypeProfileRSUCSearches_include_revincludeOperations
BundleSupported Profiles
  eICR Document Bundle
  RR Document Bundle
  US Public Health Reporting Bundle		y
ValueSethttp://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valuesety
PlanDefinitionhttp://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinitiony
Person y
Subscription y
Libraryhttp://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset-libraryy

Resource Conformance: supported Bundle

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

Supported Profiles

eICR Document Bundle
RR Document Bundle
US Public Health 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.

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

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

Interaction summary
  • Supports read.