Health Care Surveys Content Implementation Guide
0.1.0 - STU 1 Ballot

This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) Healthcare Surveys Reporting Content IG (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

CapabilityStatement: Health Care Surveys EHR Capability Statement

Raw OpenAPI-Swagger Definition file | Download

EHR

(Requirements Definition Capability Statement)

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

Published by: HL7 International - Public Health Work Group

This profile defines the expected capabilities of the EHR actor to support the health care surveys use cases. This actor is responsible for publishing Subscription Topics based on Named Events, generate notifications base on subscriptions and support US Core FHIR APIs.

General

FHIR Version: 4.0.1
Supported formats: json

REST behavior

The primary focus of the EHR 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 EHR needs to meet the security requirements as outlined in the Formal Specification - Security Section.

US Core Support

The 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 Close 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