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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
MedMorph Backend Service App |
This profile defines the expected capabilities of the ‘‘Backend Service App’’ actor when conforming to the MedMorph Architecture Implementation Guide. |
MedMorph EHR |
This profile defines the expected capabilities of the ‘‘EHR’’ actor when conforming to the MedMorph Architecture Implementation Guide. This role is responsible for allowing creation, modification and deletion of Subscriptions and allows searching and retrieval of resources using US Core APIs. |
MedMorph Knowledge Artifact Repository |
This profile defines the expected capabilities of the ‘‘Knowledge Artifact Repository’’ actor when conforming to the MedMorph Architecture Implementation Guide. This role is responsible for allowing creation, modification, and hosting of the Knowledge Artifacts. |
MedMorph Public Health Authority |
This profile defines the expected capabilities of the ‘‘Public Health Authority’’ actor when conforming to the MedMorph Architecture Implementation Guide. This role is responsible for defining Knowledge Artifacts, receiving public health reports, and submitting responses back to clinical care organizations. |
MedMorph Trust Service Provider |
This profile defines the expected capabilities of the ‘‘Trust Service Provider’’ actor when conforming to the MedMorph Architecture Implementation Guide. This role is responsible for allowing creation, modification, and hosting of the Knowledge Artifacts. |
MedMorph Trusted Third Party |
This profile defines the expected capabilities of the ‘‘Trusted Third Party’’ actor when conforming to the MedMorph Architecture Implementation Guide. This role is responsible for receiving messages and forwarding messages from clinical care to PHA/Research Organization and send responses back from PHA/Research Organization to clinical care. |
These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide
Generate Anonymized Bundle |
Generates an anonymized bundle taking an instance of a Bundle containing Protected Health Information (PHI)/personally identifiable information (PII) data. The anonymization algorithm to be used is left to the implementers of the operation. |
Generate De-Identified Bundle |
Generates a de-identified bundle taking an instance of a Bundle containing PHI/PII data. The de-identification algorithm to be used is left to the implementers of the operation. |
Generate Pseudonymized Bundle |
Generates a pseudonymized bundle taking an instance of a Bundle containing PHI/PII data. The pseudonymization algorithm to be used is left to the implementers of the operation. |
Generate Re-Identified Bundle |
Generates a re-identified bundle taking an instance of a Bundle containing PHI/PII data. The re-identification algorithm to be used is left to the implementers of the operation. |
These define constraints on FHIR resources for systems conforming to this implementation guide
US Public Health Content Bundle |
Bundle Resource profile for exchanging public health messages, knowledge artifacts or content. |
US Public Health Reporting Bundle |
Bundle Resource profile for exchanging one of public health messages, knowledge artifacts or content. |
USPublicHealthSpecificationBundle |
Bundle Resource profile for exchanging one of MedMorph messages, knowledge artifacts or content. |
USPublicHealthResponseBundle |
Bundle Resource profile for exchanging one of MedMorph messages, knowledge artifacts or content. |
USPublicHealthCommunication |
This is the Communication Resource profile for the IG. |
USPublicHealthEndpoint |
This is the Endpoint Resource profile for the IG used to specify receivers addresses |
USPublicHealthSurveyPractitionerGroup |
Group Resource profile for specifying survey participant groups, research groups. |
ResearchParticipantGroup |
Group Resource profile for specifying survey participant groups, research groups. |
USPublicHealthMessageHeader |
This is the MessageHeader Resource profile for the IG. |
EncounterCloseSubscriptionTopic |
This is the Backport Subscription Resource profile for the IG used to specify encounter-start Subscription Topic |
EncounterStartSubscriptionTopic |
This is the Backport Subscription Resource profile for the IG used to specify encounter-start Subscription Topic |
USPublicHealthPlanDefinition |
This is the PlanDefinition Resource profile for the IG. |
USPublicHealthValueSet |
This is the ValueSet Resource profile for the IG for specifying various valuesets to be used in public health reporting. |
These define constraints on FHIR data types for systems conforming to this implementation guide
US Public Health FHIR Query Pattern Extension |
Supports communicating the FHIR query for a given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be extended to be able to provide an Endpoint or CapabilityStatement to provide this information. If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used. This is not a resolveable URL, and that it will contain 1) No base canonical (so it’s a relative query), and 2) Parameters using tokens that are denoted using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId |
ResponseMessageStatus |
Indicates the result of processing messages submitted from clinical care to Public Health Authority (PHA) or Research Organizations. |
DataEncrypted |
Indicates whether the data in the content bundle is encrypted or not. |
MessageProcessingCategory |
Indicates how systems have to deal with messages in terms of duplicates, lack of responses. |
USPublicHealthNamedEventType |
Indicates the types of named events to subscribe to from the EHR. |
ReceiverAddress |
Indicates the address where the report has to be sent. |
AuthorSignature |
Indicates the signature of the author who created the PlanDefinition. |
AsyncIndicator |
True indicates that the messages resulting from the PlanDefinition are expected to be processed asynchronously. |
ExpectedResponseTime |
Indicates the maximum time the sender has to wait to get a response, beyond which the message is assumed to have failed to reach the destination. |
These define sets of codes used by systems conforming to this implementation guide
US Public Health Message Types |
The US Public Health Message Types Value Set is a ‘starter set’ of codes for uniquely identifying messages in MessageHeader instances contained within a reporting bundle. |
US Public Health PlanDefinition Action |
The US Public Health PlanDefinition Action Value Set is a ‘starter set’ of codes for uniquely identifying actions in PlanDefinition instances. |
US Public Health Response Message Processing Status Codes |
The US Public Health Message Processing Status Codes Value Set is a ‘starter set’ of codes for identifying response message processing status for each message that was previously submitted from clinical care to PHA or Research Organizations. |
US Public Health TriggerDefinition NamedEvent |
The US Public Health TriggerDefinition NamedEvent Value Set is a ‘starter set’ of codes for uniquely identifying named events in TriggerDefinition instances contained within a PlanDefinition. |
These define new code systems used by systems conforming to this implementation guide
US Public Health Message Type Codes |
The US Public Health Message Header Events CodeSystem is a ‘starter set’ of codes supported for identifying types of messages being exchanged. |
US Public Health PlanDefinition Action Codes |
The US Public Health PlanDefinition Actions CodeSystem is a ‘starter set’ of codes supported for identifying actions in PlanDefinition. |
US Public Health CodeSystem for Response Message Processing Status Codes |
The US Public Health Response Message Processing Status CodeSystem is a ‘starter set’ of codes supported for identifying response message processing status codes. |
US Public Health TriggerDefinition Named Events |
The US Public Health TriggerDefinition NamedEvents CodeSystem is a ‘starter set’ of codes supported for identifying named events to subscribe to in clinical workflows. |
US Public Health CodeSystem for ValueSet Use Context Codes |
The US Public Health UseContext CodeSystem is a ‘starter set’ of codes supported for identifying use context codes in ValueSet. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like
Encounter Start Subscription Topic Example |
Encounter Start Subscription Topic Example |
Encounter Close Subscription Topic Example |
Encounter Close Subscription Topic Example |
Patient 1 - Example |
An example showing a Patient |
Practitioner Example |
An example showing a Practitioner |
Public Health Organization Example |
An example showing a Public Health Organization |
Healthcare Organization Example |
An example showing a HealthCare Organization |
Public Health Organization Endpoint example |
An example showing a Public Health Organization Endpoint |
Healthcare Organization Endpoint example |
An example showing a Healthcare Organization Endpoint |
Plan Definition example for Cancer Reporting |
An example showing a Plan Definition for Cancer reporting |
MessageHeader example used in the Cancer Reporting Bundle sent from Healthcare org to PHA |
MessageHeader example used in the Cancer Reporting Bundle sent from Healthcare org to PHA |
ValueSet example for Cancer Reporting |
An example showing a ValueSet for Cancer reporting |
Group example showing patients participating in research at a healthcare organization |
Group example showing patients participating in research at a healthcare organization |
Group example showing Providers participating in healthcare surveys |
Group example showing Providers participating in healthcare surveys |
Communication example from PHA to Healthcare in response to a received cancer report |
Communication example from PHA to Healthcare in response to a received cancer report |
Example of a Content Bundle containing Patient Data |
Example of a Content Bundle containing Patient Data |
Example of a Reporting Bundle containing Message Header and Content Bundle |
Example of a Reporting Bundle containing Message Header and Content Bundle |
Example of a Specification Bundle for a Knowledge Artifact containing a PlanDefinition and ValueSet |
Example of a Specification Bundle for a Knowledge Artifact containing a PlanDefinition and ValueSet |
Example of a Response Bundle for a submitted message containing a communication resource. |
Example of a Response Bundle for a submitted message containing a communication resource. |