DRAFT - CodeX Implementation Guide: Integrated Trial Matching for Cancer Patients and Providers, published by . This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/standardhealth/fsh-pct/ and changes regularly. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Clinical Trial Match Service - JSON Representation

Draft as of 2024-03-07

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "ClinicalTrialMatchService",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/ResearchStudy/$match</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>zipCode</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The zipcode of the area in which to search</p>\n</div></td></tr><tr><td>IN</td><td>travelRadius</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The distance from the zipcode to include in the search radius</p>\n</div></td></tr><tr><td>IN</td><td>phase</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The phase of the clinical trial</p>\n</div></td></tr><tr><td>IN</td><td>recruitmentStatus</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The recruitement status of the clinical trial</p>\n</div></td></tr><tr><td>IN</td><td>trialMatchClinicalData</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>TrialMatchDataBundle that contains the mCODE clinical patient data</p>\n</div></td></tr><tr><td>OUT</td><td>trialMatchOutput</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>TrialMatchResultSet that contains the results from the Clinical Trial Match Service</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://mcodeinitiative.org/codex/us/patient.clinical.trial.matching/OperationDefinition/ClinicalTrialMatchService",
  "version" : "0.1.0",
  "name" : "clinicalTrialMatchService",
  "title" : "Clinical Trial Match Service",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2024-03-07T13:30:33+00:00",
  "contact" : [
    {
      "name" : "CodeX Team",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://mitre.org/"
        },
        {
          "system" : "email",
          "value" : "sbratt@mitre.org"
        }
      ]
    }
  ],
  "description" : "Operation defintion for clinical trial matching service",
  "code" : "match",
  "resource" : [
    "ResearchStudy"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "zipCode",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The zipcode of the area in which to search",
      "type" : "string"
    },
    {
      "name" : "travelRadius",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The distance from the zipcode to include in the search radius",
      "type" : "string"
    },
    {
      "name" : "phase",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The phase of the clinical trial",
      "type" : "string"
    },
    {
      "name" : "recruitmentStatus",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The recruitement status of the clinical trial",
      "type" : "string"
    },
    {
      "name" : "trialMatchClinicalData",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "TrialMatchDataBundle that contains the mCODE clinical patient data",
      "type" : "Bundle"
    },
    {
      "name" : "trialMatchOutput",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "TrialMatchResultSet that contains the results from the Clinical Trial Match Service",
      "type" : "Bundle"
    }
  ]
}