⚠️ This is a developmental version of the guide and is under active development. Content may change at any time without notice. No official release has been made. The final base canonical URL and hosting location have not yet been determined. This guide should not be used for production implementations.

2.4. Example CTM CDS Hooks Cards

2.4.1. Purpose

This page provides representative examples of CTM CDS Hooks cards for Pattern A.These examples illustrate recommended semantic usage patterns for the CTM card categories described on the CDS Hooks Card Guidance page. They are not intended to define the only acceptable representations.

For guidance on when to use each category, the recommended card behavior, and the minimal card content per category, see the CDS Hooks Card Guidance for USCDI+ CTM section on the CDS Hooks Card Guidance page.

2.4.2. Example 1 - Match / Multiple Matches Found

2.4.2.1. Representative Use

Use this type of card when the CTM Matching Service identifies one or more potential clinical trial matches using the available CTM data.

{
  "cards": [
    {
      "summary": "Potential clinical trial matches identified",
      "indicator": "info",
      "detail": "The CTM service identified one or more candidate clinical trials based on the CTM-relevant data available for this patient. Review trial details and determine whether follow-up is appropriate.",
      "source": {
        "label": "CTM Matching Service"
      },
      "links": [
        {
          "label": "View candidate trial details",
          "url": "https://ctm.example.org/matches/12345",
          "type": "absolute"
        }
      ]
    }
  ]
}

2.4.2.2. Notes

• indicator uses info
• detail explains that these are candidate matches
• links provide follow-up access without requiring additional result standardization

2.4.3. Example 2 - Missing Information

2.4.3.1. Representative Use

Use this type of card when CTM evaluation could not be completed meaningfully because important CTM-relevant data elements are missing, incomplete, or unavailable.

{
  "cards": [
    {
      "summary": "Insufficient data for full clinical trial matching",
      "indicator": "warning",
      "detail": "The CTM service could not complete a meaningful trial matching evaluation because important CTM data elements were not available in the current interaction. Missing or incomplete information may include clinical performance status, staging, laboratory data, or other CTM-relevant data.",
      "source": {
        "label": "CTM Matching Service"
      },
      "links": [
        {
          "label": "Review CTM data requirements",
          "url": "https://ctm.example.org/data-requirements",
          "type": "absolute"
        }
      ]
    }
  ]
}

2.4.3.2. Notes

• indicator uses warning
• summary distinguishes this from a completed no-match result
• detail describes the issue at a useful but non-prescriptive level

2.4.4. Example 3 - No Match

2.4.4.1. Representative Use

Use this type of card when CTM evaluation completed successfully using the available data and no candidate clinical trial matches were identified.

{
  "cards": [
    {
      "summary": "No candidate clinical trial matches found",
      "indicator": "info",
      "detail": "The CTM service completed evaluation using the CTM-relevant data available for this patient and did not identify candidate clinical trial matches at this time.",
      "source": {
        "label": "CTM Matching Service"
      }
    }
  ]
}

2.4.4.2. Notes

• indicator uses info
• The card clearly communicates that matching completed successfully
• This category should not be used when evaluation was limited by missing or incomplete data