Common Data Models Harmonization
1.0.0 - STU 1 Publication

This page is part of the Common Data Models Harmonization FHIR IG (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

CapabilityStatement: Cdmh EHR Capability Statement

Raw OpenAPI-Swagger Definition file | Download

EHR

(Requirements Definition Capability Statement)

Canonical URL: http://hl7.org/fhir/us/cdmh/CapabilityStatement/cdmh-ehr

Published by: HL7 International - Public Health Work Group

This profile defines the expected capabilities of the EHR actor to support the CDMH IG use cases. This actor is responsible for supporting ResearchStudy, Group Resource, Group export operations along with the CDMH IG and US Core profiles.

General

FHIR Version: 4.0.1
Supported formats: json

REST behavior

The primary focus of the EHR is to allow the creation of a ResearchStudy, Group resource and support the Group export operation for the CDMH IG and US Core profiles.

Security:

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

US Core Support

The EHR SHALL support the profiles listed in US Core Server capability statement as foundational FHIR profiles needed by the CDMH IG.


CDMH IG Profiles

The EHR SHOULD support the profiles listed in CDMH IG for populating multiple common data models.


Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete Operations
ResearchStudy SHALL SHALL SHALL
Group SHALL SHALL SHALL Bulk Data IG: Group/$export: SHALL
US Core Profiles SHALL
CDMH IG Profiles SHALL


ResearchStudy

Profile: CdmhResearchStudy

Interactions

Name Description
  search

Allows creation of a specific ResearchStudy resource instances to record participants in a research program.
  search

Allows searching of specific ResearchStudy resource profile instances.
  read

Allows retrieval of specific ResearchStudy resource profile instances


Search

Parameter Type Definition & Chaining
identifier token Search using identifiers.
title string Search using ResearchStudy name which represents the Research program name.

Group

Profile: CdmhGroup

Interactions

Name Description
  search

Allows creation of a specific Group resource instances to record participants in a research program.
  search

Allows searching of specific Group resource profile instances.
  read

Allows retrieval of specific Group resource profile instances
  Bulk Data IG: Group/$export operation

Allows retrieval of specific data associated with patients who are part of the Group.


Search

Parameter Type Definition & Chaining
identifier token Search using identifiers.
name string Search using Group name which represents the Research program name.

US Core Profiles

Profile: Profiles listed in US Core

Interactions

Name Description
  read

Allows retrieval of specific US Core resource profile instances as part of the Group/$export operation.


CDMH IG Profiles

Profile: Profiles listed in CDMH IG

Interactions

Name Description
  read

Allows retrieval of specific CDMH resource profile instances as part of the Group/$export operation.