Health Care Surveys Content Implementation Guide (IG)
1.0.1 - CI Build United States of America flag

Health Care Surveys Content Implementation Guide (IG), published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 1.0.1). This version is based on the current content of https://github.com/HL7/fhir-health-care-surveys-reporting-ig/ and changes regularly. See the Directory of published versions

CapabilityStatement: Health Care Surveys EHR Capability Statement

Official URL: http://hl7.org/fhir/us/health-care-surveys-reporting/CapabilityStatement/health-care-surveys-reporting-data-source Version: 1.0.1
Draft as of 2020-12-06 Computable Name: HealthcareSurveysReportingEHRCapabilityStatement

This profile defines the expected capabilities of the ‘‘EHR’’ actor when conforming to the Health Care Surveys Content Implementation Guide. This role is responsible for allowing creation, modification and deletion of Subscriptions and allows searching and retrieval of resources using US Core APIs.

Raw OpenAPI-Swagger Definition file | Download

Data Source (e.g EHR)

(Requirements Definition Capability Statement)

Canonical URL: http://hl7.org/fhir/us/health-care-surveys-reporting/CapabilityStatement/health-care-surveys-reporting-data-source

Published by: HL7 International - Public Health Work Group

This profile defines the expected capabilities of the Data Source (e.g EHR) actor to support the health care surveys use cases. This actor is responsible for notifying HDEA based on Named Events and support US Core FHIR APIs for data queries.

General

FHIR Version: 4.0.1
Supported formats: json

REST behavior

The primary focus of the Data Source actor is to allow the creation, modification and deletion of Subscriptions, notify subscribers based on subscriptions and support US Core APIs.

Security:

Implementations must meet the general security requirements documented in FHIR Security guidance.

In addition the Data Source (e.g EHR) needs to meet the security requirements as outlined in the Formal Specification - SMART on FHIR Backend Services Requirements.

US Core Support

The Data Source (e.g EHR) SHALL implement the US Core Server capability statement as foundational FHIR APIs needed by the health care surveys IG.


Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete Operations
Backported Subscription SHALL SHALL SHALL SHALL $topic-list $status
Encounter End Subscription Topic SHALL SHALL SHALL SHALL
Backport Subscription Notification Bundle SHALL
Backport Subscription Status SHALL
US Core APIs SHALL SHALL
MedicationAdministration SHALL SHALL


Subscription (Includes Subscriptions for encounter-close Subscription Topic)

Profile: http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription.html

Interactions

Name Description
  read

Allows retrieval of a specific Subscription instance.
  create

Allows creation of Subscription instances
  update

Allows Update of Subscription instances
  update

Allows deletion of Subscription instances


Bundle (Notifcation Bundle for Subscriptions)

Profile: http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription-notification.html)

Interactions

Name Description
  create

Allows creation of Notifcation Bundles for Subscriptions



Parameters (Parameters Profile to retrieve Subscription Status)

Profile: ("http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscriptionstatus.html")

Interactions

Name Description
  read

Allows clients to request Subscription Status for Subscriptions



US Core APIs

Profile: None

Interactions

Name Description
  search

Allows searching of specific US Core resource profile instances.
  read

Allows retrieval of specific US Core resource profile instances


MedicationAdministation

Profile: ("hcs-medicationadministration.html")

Interactions

Name Description
  search

Allows searching of specific MedicationAdministration resource profile instances.
  read

Allows retrieval of specific MedicationAdministration resource profile instances