| Package | hl7.fhir.us.medmorph |
| Type | CapabilityStatement |
| Id | medmorph-healthdata-exchange-app-client |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/medmorph/https://build.fhir.org/ig/HL7/fhir-medmorph/CapabilityStatement-medmorph-healthdata-exchange-app-client.html |
| URL | http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-healthdata-exchange-app-client |
| Version | 1.0.0 |
| Status | draft |
| Date | 2020-12-06 |
| Name | HealthDataExchangeAppClientMode |
| Title | Health Data Exchange App (HDEA) Client Application - (MedMorph backend services app) |
| Realm | us |
| Authority | hl7 |
| 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. |
| Kind | requirements |
No resources found
| OperationDefinition | |
| Bundle-anonymize | Generate Anonymized Bundle |
| Bundle-de-identify | Generate De-Identified Bundle |
| Bundle-pseudonymize | Generate Pseudonymized Bundle |
| Bundle-re-identify | Generate Re-Identified Bundle |
| StructureDefinition | |
| us-ph-content-bundle | US Public Health Content Bundle |
| us-ph-plandefinition | US Public Health PlanDefinition |
| us-ph-reporting-bundle | US Public Health Reporting Bundle |
Note: links and images are rebased to the (stated) source
(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.
| FHIR Version: | 4.0.1 |
|---|---|
| Supported formats: | json |
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 | Search | Read | Read Version | Instance History | Resource History | Create | Update | Delete |
|---|---|---|---|---|---|---|---|---|
| PlanDefinition (Profile) | SHALL | SHALL | SHOULD |
Profile: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition
| 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. |
The HDEA SHALL be capable of invoking these operations passing and collecting FHIR resources
FHIR{
"resourceType": "CapabilityStatement",
"id": "medmorph-healthdata-exchange-app-client",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"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"
}
]
}
]
}