Package | hl7.fhir.us.ecr |
Type | CapabilityStatement |
Id | capabilitystatement-ersd-client |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/ecr/https://build.fhir.org/ig/HL7/case-reporting/CapabilityStatement-capabilitystatement-ersd-client.html |
URL | http://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ersd-client |
Version | 2.1.2 |
Status | draft |
Date | 2019-08-23 |
Name | CapabilityStatement_eRSD_Client |
Title | Capability Statement eRSD Client |
Realm | us |
Authority | hl7 |
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 |
No resources found
StructureDefinition | |
eicr-document-bundle | eICR Document Bundle |
ersd-plandefinition | eRSD PlanDefinition |
rr-document-bundle | RR Document Bundle |
us-ph-reporting-bundle | US Public Health Reporting Bundle |
us-ph-valueset-library | US Public Health ValueSet Library |
us-ph-valueset | US Public Health ValueSet |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement capabilitystatement-ersd-client
application/xml
, application/json
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.
client
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|
Bundle | Supported Profiles eICR Document Bundle RR Document Bundle US Public Health Reporting Bundle | y | |||||||
ValueSet | http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset | y | |||||||
PlanDefinition | http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition | y | |||||||
Person | y | ||||||||
Subscription | y | ||||||||
Library | http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-valueset-library | y |
eICR Document Bundle
RR Document Bundle
US Public Health Reporting Bundle
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.
read
.read
.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.
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.
read
.{ "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" } ] } ] } ] }