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

This page is part of the electronic Case Reporting (eCR) (v1.1.0: STU 2 on FHIR R4 Ballot 1) 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

CapabilityStatement: eRSD Client CapabilityStatement

Raw OpenAPI-Swagger Definition file | Download

id capabilitystatement-ersd-client
url http://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ersd-client
version 1.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
description

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.
kind requirements
fhirVersion 4.0.1
format xml
format json
rest
mode client
resource
type Bundle
supportedProfile http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle
supportedProfile http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-message-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
capabilitystatement-expectation
  • SHALL
code read
resource
type ValueSet
profile http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-valueset
documentation A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between CodeSystem definitions and their use in coded elements.
interaction
capabilitystatement-expectation
  • SHALL
code read
resource
type PlanDefinition
profile http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition
documentation A plan definition is a pre-defined group of actions to be taken in particular circumstances, such as the triggering of a ERSD subscription, often including conditional elements, options, and other decision points.
interaction
capabilitystatement-expectation
  • SHALL
code read
resource
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
capabilitystatement-expectation
  • MAY
code read
resource
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
capabilitystatement-expectation
  • MAY
code read
resource
type Library
profile http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset-library
interaction
capabilitystatement-expectation
  • SHALL
code read