{ "resourceType" : "CapabilityStatement", "id" : "medmorph-healthdata-exchange-app-client", "text" : { "status" : "generated", "div" : "
\n

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

\n

(Requirements Definition Capability Statement)

\n

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

\n

Published by: HL7 International - Public Health Work Group\n

\n

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. \n 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.

\n

General

\n
\n \n \n \n \n \n \n \n \n \n \n \n
FHIR Version:4.0.1
Supported formats:json
\n
\n

REST behavior

\n

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.

\n

\n Security:\n

\n

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

\n

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

\n

Resource summary

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ResourceSearchReadRead VersionInstance HistoryResource HistoryCreateUpdateDelete
PlanDefinition (Profile)\n SHALL\n \n SHALL\n \n SHOULD\n \n \n \n \n \n
\n
\n \n
\n
\n

\n PlanDefinition\n

\n

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

\n

Interactions

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameDescription
\n \u00a0\n search-type\n \n

Allows discovery of existing PlanDefinition instances representing Knowledge Artifacts.

\n
\n \u00a0\n read\n \n

Allows retrieval of a specific PlanDefinition instance.

\n
\n \u00a0\n vread\n \n

Allows retrieval of a historical version of a PlanDefinition instance.

\n
\n \u00a0\n create\n \n

Allows creation of PlanDefinition instances

\n
\n \u00a0\n update\n \n

Allows Updating of PlanDefinition instances

\n
\n
\n
\n
\n

Search

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterTypeDefinition & Chaining
identifiertokenSearch using identifiers as allowed according to the FHIR specification.
namestringSearch using PlanDefinition name.
publisherstringSearch using publisher name.
titlestringSearch using title.
versionstringSearch using version.
name and versionstring, stringSearch using name and version.
\n
\n
\n
\n \n

FHIR Operations summary

\n

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

\n \n \n
\n \n
" }, "url" : "http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-healthdata-exchange-app-client", "version" : "1.0.0", "name" : "HealthDataExchangeAppClientMode", "title" : "Health Data Exchange App (HDEA) Client Application - (MedMorph backend services app)", "status" : "draft", "date" : "2020-12-06", "publisher" : "HL7 International - Public Health Work Group", "contact" : [{ "telecom" : [{ "system" : "url", "value" : "http://hl7.org/Special/committees/pher" }] }], "description" : "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.", "jurisdiction" : [{ "coding" : [{ "system" : "urn:iso:std:iso:3166", "code" : "US" }] }], "kind" : "requirements", "fhirVersion" : "4.0.1", "format" : ["json"], "rest" : [{ "mode" : "client", "documentation" : "The focus of the HDEA is to act as a client and access Knowledge Artifacts, create subscriptions, receive notifications, create message bundles, invoke trust services and submit reports. ", "security" : { "description" : "Implementations must meet the general security requirements documented in the security section of the implementation guide." }, "resource" : [{ "type" : "PlanDefinition", "supportedProfile" : ["http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition"], "interaction" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "code" : "search-type", "documentation" : "Allows discovery of existing PlanDefinition instances." }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "code" : "read", "documentation" : "Allows retrieval of a specific PlanDefinition instance." }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHOULD" }], "code" : "vread", "documentation" : "Allows retrieval of a historical version of a PlanDefinition instance." }], "searchParam" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "identifier", "definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier", "type" : "token" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "name", "definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-name", "type" : "string" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "publisher", "definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-publisher", "type" : "string" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "title", "definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-title", "type" : "string" }] }, { "type" : "Bundle", "supportedProfile" : ["http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle", "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-content-bundle"], "operation" : [{ "name" : "pseudonymize", "definition" : "http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-pseudonymize" }, { "name" : "anonymize", "definition" : "http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-anonymize" }, { "name" : "de-identify", "definition" : "http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-de-identify" }, { "name" : "re-identify", "definition" : "http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-re-identify" }] }], "operation" : [{ "name" : "process-message", "definition" : "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message" }] }, { "mode" : "server", "documentation" : "The focus of the HDEA as a Server is to expose $process-message endpoint at the root of the FHIR server.", "security" : { "description" : "Implementations must meet the general security requirements documented in the security section of the implementation guide." }, "operation" : [{ "name" : "process-message", "definition" : "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message" }] }] }