Making Electronic Data More available for Research and Public Health (MedMorph)
1.0.0 - STU 1

Making Electronic Data More available for Research and Public Health (MedMorph), published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-medmorph/ and changes regularly. See the Directory of published versions

## CapabilityStatement: Health Data Exchange App (HDEA) Client Application - (MedMorph backend services app)

Official URL: http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-healthdata-exchange-app-client | Version: 1.0.0
Draft as of 2020-12-06 | Computable Name: HealthDataExchangeAppClientMode

This CapabilityStatement defines the expected capabilities of the HDEA actor when conforming to the MedMorph RA IG and playing the role of a client initiating the interactions with both Data Sources and Data Receivers/TTP.

Raw OpenAPI-Swagger Definition file | Download

## Health Data Exchange App (HDEA) Client Application - (MedMorph backend services app)

(Requirements Definition Capability Statement)

Canonical URL: http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-healthdata-exchange-app-client

Published by: HL7 International - Public Health Work Group

This CapabilityStatement defines the expected capabilities of the HDEA actor when conforming to the MedMorph IG and acting as a client initiating the interactions with both the Data Source and the Data Receivers/TTP. This actor is responsible for consuming Knowledge Artifacts created by Public Health Agencies and/or Research Organizations, subscribing to topics in Data Sources using Named Events, Creating the submission reports and finally submitting the reports to the Data Receiver.

## General

FHIR Version: | 4.0.1
Supported formats: | json

## REST behavior

The primary focus of the HDEA is to consuming Knowledge Artifacts created by PHA/RO, subscribing to topics in Data Sources using Named Events, creating the submission reports and finally submitting the reports to the Data Receivers.

Security:

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

In addition the HDEA needs to meet the security requirements as outlined in the Formal Specification - Security Section.

### Resource summary

Resource | Search | Read | Read Version | Instance History | Resource History | Create | Update | Delete
--- | --- | --- | --- | --- | --- | --- | --- | ---
PlanDefinition (Profile) | SHALL | SHALL | SHOULD |  |  |  |  |

### PlanDefinition

Profile: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition

#### Interactions

Name | Description
--- | ---
search-type | Allows discovery of existing PlanDefinition instances representing Knowledge Artifacts.
read | Allows retrieval of a specific PlanDefinition instance.
vread | Allows retrieval of a historical version of a PlanDefinition instance.
create | Allows creation of PlanDefinition instances
update | Allows Updating of PlanDefinition instances

#### Search

Parameter | Type | Definition & Chaining
--- | --- | ---
identifier | token | Search using identifiers as allowed according to the FHIR specification.
name | string | Search using PlanDefinition name.
publisher | string | Search using publisher name.
title | string | Search using title.
version | string | Search using version.
name and version | string, string | Search using name and version.

### FHIR Operations summary

The HDEA SHALL be capable of invoking these operations passing and collecting FHIR resources

- Bundle pseudonymize
- Bundle anonymize
- Bundle de-identify
- Bundle re-identify
- Bundle hash
- process-message