Making EHR Data More available for Research and Public Health (MedMorph)
0.2.0 - STU 1 draft

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

CapabilityStatement: MedMorph Backend Service App

Raw OpenAPI-Swagger Definition file | Download

BackendServiceApp

(Requirements Definition Capability Statement)

Canonical URL: http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-backend-service-app

Published by: HL7 International - Public Health Work Group

This profile defines the expected capabilities of the MedMorph Backend Service App actor. This actor is responsible for consuming Knowledge Artifacts created by Public Health Agencies and/or Research Organizations, subscribing to topics in EHR using Named Events, Creating the submission reports to be sent to the PHA and finally submitting the reports to the PHA/Research Organization.

General

FHIR Version: 4.0.1
Supported formats: json

REST behavior

The primary focus of the Backend Service App is to consuming Knowledge Artifacts created by Public Health Agencies and/or Research Organizations, subscribing to topics in EHR using Named Events, Creating the submission reports to be sent to the PHA and finally submitting the reports to the PHA/Research Organization.

Security:

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

In addition the Backend Service App 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
Subscription (Profile) SHALL SHALL SHALL SHALL
Reporting Bundle (Profile) SHALL
Content Bundle (Profile) SHALL
MessageHeader (Profile) SHALL

FHIR Operations summary

The following FHIR operations SHALL be supported by the Backend Service App.



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.


Subscription

Profile: None

Interactions

Name Description
  read

Allows retrieval of a specific Subscription instance.
  create

Allows creation of Subscription instances
  update

Allows Updating of Subscription instances
  update

Allows Deletion of Subscription instances


Bundle

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

Interactions

Name Description
  create

Allows creation of ReportingBundle instances


Bundle

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

Interactions

Name Description
  create

Allows creation of ContentBundle instances


MessageHeader

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

Interactions

Name Description
  create

Allows creation of MessageHeader instances