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

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

Draft as of 2020-12-06

Raw ttl | Download

    @prefix fhir: <http://hl7.org/fhir/> .
    @prefix owl: <http://www.w3.org/2002/07/owl#> .
    @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
    @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

    # - resource -------------------------------------------------------------------

     a fhir:CapabilityStatement ;
      fhir:nodeRole fhir:treeRoot ;
      fhir:id [ fhir:v "medmorph-healthdata-exchange-app-client"] ; #
      fhir:text [
    fhir:status [ fhir:v "generated" ] ;
    fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <h2>Health Data Exchange App  (HDEA) Client Application - (MedMorph backend services app)</h2>\n      <p>(Requirements Definition Capability Statement)</p>\n      <p>Canonical URL: http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-healthdata-exchange-app-client</p>\n      <p>Published by: <b>HL7 International - Public Health Work Group</b>\n      </p>\n      <p>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. </p>\n      <h2>General</h2>\n      <div class=\"table-wrapper\">\n        <table>\n          <tbody>\n            <tr>\n              <th>FHIR Version:</th>\n              <td>4.0.1</td>\n            </tr>\n            <tr>\n              <th>Supported formats:</th>\n              <td>json</td>\n            </tr>\n          </tbody>\n        </table>\n      </div>\n      <h2>REST  behavior</h2>\n      <p>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.</p>\n      <p>\n        <b>Security:</b>\n      </p>\n      <p>Implementations must meet the general security requirements documented in FHIR <a href=\"http://hl7.org/fhir/security.html\">Security guidance</a>.</p>\n      <p>In addition the HDEA needs to meet the security requirements as outlined in the <a href=\"spec.html#authentication-and-authorization-requirements\">Formal Specification - Security Section.</a></p>\n      <h3>Resource summary</h3>\n      <div class=\"table-wrapper\">\n        <table class=\"grid\">\n          <thead>\n            <tr>\n              <th>Resource</th>\n              <th>Search</th>\n              <th>Read</th>\n              <th>Read Version</th>\n              <th>Instance History</th>\n              <th>Resource History</th>\n              <th>Create</th>\n              <th>Update</th>\n              <th>Delete</th>\n            </tr>\n          </thead>\n          <tbody>\n           <tr>\n              <th>PlanDefinition (<a href=\"StructureDefinition-us-ph-plandefinition.html\">Profile</a>)</th>\n              <td>\n                <a href=\"#PlanDefinition-search-type\" title=\"Allows a user to search for existing PlanDefinition instances\">SHALL</a>\n              </td>\n              <td>\n                <a href=\"#PlanDefinition-read\" title=\"Allows retrieval of a specific PlanDefinition Resource instance \">SHALL</a>\n              </td>\n              <td>\n                <a href=\"#PlanDefinition-vread\" title=\"Allows retrieval of a specific PlanDefinition Resource instance version\">SHOULD</a>\n              </td>\n              <td>               \n              </td>\n              <td>\n              </td>\n              <td>\n              </td>\n              <td>\n              </td>\n              <td/>\n            </tr>\n          </tbody>\n        </table>\n      </div>\n      \n      <br/>\n      <br/>\n      <h3>\n        <a href=\"http://hl7.org/fhir/R4/plandefinition.html\">PlanDefinition</a>\n      </h3>\n      <p>Profile: <a href=\"StructureDefinition-us-ph-plandefinition.html\">http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition</a>\n      </p>\n      <h4>Interactions</h4>\n      <div class=\"table-wrapper\">\n        <table class=\"list\">\n          <thead>\n            <tr>\n              <th>Name</th>\n              <th>Description</th>\n            </tr>\n          </thead>\n          <tbody>\n            <tr>\n              <th>\n                <a name=\"PlanDefinition-search-type\"> </a>\n                <span>search-type</span>\n              </th>\n              <td>\n                <p>Allows discovery of existing PlanDefinition instances representing Knowledge Artifacts.</p>\n              </td>\n            </tr>\n            <tr>\n              <th>\n                <a name=\"PlanDefinition-read\"> </a>\n                <span>read</span>\n              </th>\n              <td>\n                <p>Allows retrieval of a specific PlanDefinition instance.</p>\n              </td>\n            </tr>\n            <tr>\n              <th>\n                <a name=\"PlanDefinition-vread\"> </a>\n                <span>vread</span>\n              </th>\n              <td>\n                <p>Allows retrieval of a historical version of a PlanDefinition instance.</p>\n              </td>\n            </tr>\n            <tr>\n              <th>\n                <a name=\"PlanDefinition-create\"> </a>\n                <span>create</span>\n              </th>\n              <td>\n                <p>Allows creation of PlanDefinition instances</p>\n              </td>\n            </tr> \n            <tr>\n              <th>\n                <a name=\"PlanDefinition-update\"> </a>\n                <span>update</span>\n              </th>\n              <td>\n                <p>Allows Updating of PlanDefinition instances</p>\n              </td>\n            </tr>   \n          </tbody>\n        </table>\n      </div>\n      <br/>\n      <br/>\n      <h4>Search</h4>\n      <div class=\"table-wrapper\">\n        <table class=\"list\">\n          <thead>\n            <tr>\n              <th>Parameter</th>\n              <th>Type</th>\n              <th>Definition &amp; Chaining</th>\n            </tr>\n          </thead>\n          <tbody>\n            <tr>\n              <th>identifier</th>\n              <td>token</td>\n              <td>Search using identifiers as allowed according to the FHIR specification.</td>\n            </tr>\n            <tr>\n              <th>name</th>\n              <td>string</td>\n              <td>Search using PlanDefinition name.</td>\n            </tr>\n            <tr>\n              <th>publisher</th>\n              <td>string</td>\n              <td>Search using publisher name.</td>\n            </tr>\n            <tr>\n              <th>title</th>\n              <td>string</td>\n              <td>Search using title.</td>\n            </tr>\n            <tr>\n              <th>version</th>\n              <td>string</td>\n              <td>Search using version.</td>\n            </tr>\n            <tr>\n              <th>name and version</th>\n              <td>string, string</td>\n              <td>Search using name and version.</td>\n            </tr>\n          </tbody>\n        </table>\n      </div>    \n      <br/>\n      <br/>      \n      \n      <h3>FHIR Operations summary</h3>\n        <p>The HDEA SHALL be capable of invoking these operations passing and collecting FHIR resources</p>\n      \n      <ul>\n        <li>\n          <a href=\"OperationDefinition-Bundle-pseudonymize.html\">Bundle pseudonymize</a>\n        </li>\n        <li>\n          <a href=\"OperationDefinition-Bundle-anonymize.html\">Bundle anonymize</a>\n        </li>\n        <li>\n          <a href=\"OperationDefinition-Bundle-de-identify.html\">Bundle de-identify</a>\n        </li>\n        <li>\n          <a href=\"OperationDefinition-Bundle-re-identify.html\">Bundle re-identify</a>\n        </li>\n        <li>\n          <a href=\"OperationDefinition-Bundle-hash.html\">Bundle hash</a>\n        </li>\n        <li>\n        <a href=\"http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message\">process-message</a>\n        </li>\n      </ul>\n      <br/>\n    \n    </div>"
      ] ; #
      fhir:url [ fhir:v "http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-healthdata-exchange-app-client"^^xsd:anyURI] ; #
      fhir:version [ fhir:v "1.0.0"] ; #
      fhir:name [ fhir:v "HealthDataExchangeAppClientMode"] ; #
      fhir:title [ fhir:v "Health Data Exchange App (HDEA) Client Application - (MedMorph backend services app)"] ; #
      fhir:status [ fhir:v "draft"] ; #
      fhir:date [ fhir:v "2020-12-06"^^xsd:date] ; #
      fhir:publisher [ fhir:v "HL7 International - Public Health Work Group"] ; #
      fhir:contact ( [
        ( fhir:telecom [
    fhir:system [ fhir:v "url" ] ;
    fhir:value [ fhir:v "http://hl7.org/Special/committees/pher" ]     ] )
      ] ) ; #
      fhir:description [ fhir:v "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."] ; #
      fhir:jurisdiction ( [
        ( fhir:coding [
    fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
    fhir:code [ fhir:v "US" ]     ] )
      ] ) ; #
      fhir:kind [ fhir:v "requirements"] ; #
      fhir:fhirVersion [ fhir:v "4.0.1"] ; #
      fhir:format ( [ fhir:v "json"] ) ; #
      fhir:rest ( [
    fhir:mode [ fhir:v "client" ] ;
    fhir:documentation [ fhir:v "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. " ] ;
    fhir:security [
    fhir:description [ fhir:v "Implementations must meet the general security requirements documented in the security section of the implementation guide." ]     ] ;
        ( fhir:resource [
    fhir:type [ fhir:v "PlanDefinition" ] ;
          ( fhir:supportedProfile [
    fhir:v "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition>       ] ) ;
          ( fhir:interaction [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHALL" ]         ] ) ;
    fhir:code [ fhir:v "search-type" ] ;
    fhir:documentation [ fhir:v "Allows discovery of existing PlanDefinition instances." ]       ] [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHALL" ]         ] ) ;
    fhir:code [ fhir:v "read" ] ;
    fhir:documentation [ fhir:v "Allows retrieval of a specific PlanDefinition instance." ]       ] [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHOULD" ]         ] ) ;
    fhir:code [ fhir:v "vread" ] ;
    fhir:documentation [ fhir:v "Allows retrieval of a historical version of a PlanDefinition instance." ]       ] ) ;
          ( fhir:searchParam [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHALL" ]         ] ) ;
    fhir:name [ fhir:v "identifier" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier>         ] ;
    fhir:type [ fhir:v "token" ]       ] [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHALL" ]         ] ) ;
    fhir:name [ fhir:v "name" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/SearchParameter/PlanDefinition-name"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/SearchParameter/PlanDefinition-name>         ] ;
    fhir:type [ fhir:v "string" ]       ] [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHALL" ]         ] ) ;
    fhir:name [ fhir:v "publisher" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/SearchParameter/PlanDefinition-publisher"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/SearchParameter/PlanDefinition-publisher>         ] ;
    fhir:type [ fhir:v "string" ]       ] [
            ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "SHALL" ]         ] ) ;
    fhir:name [ fhir:v "title" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/SearchParameter/PlanDefinition-title"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/SearchParameter/PlanDefinition-title>         ] ;
    fhir:type [ fhir:v "string" ]       ] )     ] [
    fhir:type [ fhir:v "Bundle" ] ;
          ( fhir:supportedProfile [
    fhir:v "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle>       ] [
    fhir:v "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-content-bundle"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-content-bundle>       ] ) ;
          ( fhir:operation [
    fhir:name [ fhir:v "pseudonymize" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-pseudonymize"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-pseudonymize>         ]       ] [
    fhir:name [ fhir:v "anonymize" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-anonymize"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-anonymize>         ]       ] [
    fhir:name [ fhir:v "de-identify" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-de-identify"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-de-identify>         ]       ] [
    fhir:name [ fhir:v "re-identify" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-re-identify"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-re-identify>         ]       ] )     ] ) ;
        ( fhir:operation [
    fhir:name [ fhir:v "process-message" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message>       ]     ] )
      ] [
    fhir:mode [ fhir:v "server" ] ;
    fhir:documentation [ fhir:v "The focus of the HDEA as a Server is to expose $process-message endpoint at the root of the FHIR server." ] ;
    fhir:security [
    fhir:description [ fhir:v "Implementations must meet the general security requirements documented in the security section of the implementation guide." ]     ] ;
        ( fhir:operation [
    fhir:name [ fhir:v "process-message" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message>       ]     ] )
      ] ) . #