Study

Description

The Study event is used to exchange information about one specific clinical study. For example, a Clinical Trial Management System may update an EHR with each new study when created or updated. This event allows for the exchange of relevant information such as study details, enrollment status, and study-related data between systems involved in clinical trials.

API endpoints for Research Study

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/research/study.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for Study

Study - Sample Payload

{
   "Meta": {
      "DataModel": "Research",
      "EventType": "Study",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "7593f01d-4b5d-437f-aaec-7f433e7173d4",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "de61f5b7-cee3-48f5-95e5-12ba6bf8075f",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID":"5a7f976d-4961-4cd1-83e2-7d0a5409a286",
            "AttemptID": "9b9d8a4e-16fc-439a-a9ed-9946253b8cd0"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Study": {
      "Identifiers": [
         {
            "ID": "2012P770957F",
            "IDType": "Org ID"
         },
         {
            "ID": "NCT02798255",
            "IDType": "NCT"
         }
      ],
      "Title": "Effect of Added Varnum Mouthpiece on Pharyngeal Collapsibility and Sleep Apnea Severity in Mouth Breathers.",
      "Type": "Interventional",
      "Sponsor": {
         "ID": null,
         "Name": "David Andrew Wellman"
      },
      "PrincipalInvestigator": {
         "ID": null,
         "IDType": null,
         "FirstName": "Andrew",
         "LastName": "Wellman",
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": "6174078483"
         },
         "Location": {
            "Type": null,
            "Facility": "Medicare Child and Women's Hospital",
            "Department": null,
            "Room": null
         }
      },
      "Coordinators": [
         {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Alwin",
            "LastName": "Jackson",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "234 Avenue St.",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "53703",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": "+16085551234"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         }
      ],
      "Description": "Test the effect of added a single-use Varnum mouthpiece on pharyngeal collapsibility and\n    obstructive sleep apnea (OSA) severity in patients who identify themselves as mouth\n    breathers. Research indicates that nasal breathing not only may improve sleep apnea but it\n    also increases circulation, blood oxygen, and carbon dioxide levels, slows the breathing\n    rate, and improves overall lung volumes. Thus, the investigators will test whether a\n    single-use Varnum mouthpiece can improve pharyngeal collapsibility and OSA severity in mouth\n    breathers.",
      "Status": "Completed",
      "StartDateTime": "2016-06-02T04:00:00.000Z",
      "Conditions": [
         {
            "Code": null,
            "CodeSystem": null,
            "CodeSystemName": null,
            "Name": "Obstructive Sleep",
            "AltCodes": []
         }
      ],
      "Design": {
         "Purpose": "Treatment",
         "Phase": null
      },
      "Eligibility": {
         "Gender": "All",
         "MinimumAge": 21,
         "MaximumAge": 70
      },
      "Location": {
         "Type": null,
         "Facility": "Brigham and Women's Hospital",
         "Department": "Sleep Disorders Research Program BriMedicare Child and Women's Hospital",
         "Room": null,
         "Address": {
            "StreetAddress": null,
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "02115",
            "County": null,
            "Country": null
         }
      }
   },
   "Protocols": [
      {
         "ID": "P1",
         "IDType": "CELL",
         "Description": "Protocol 1",
         "Cycles": [
            {
               "ID": "P1.C1",
               "IDType": "CYCLE",
               "Description": "Cycle 1",
               "StartDate": "2019-01-01",
               "EndDate": "2019-01-31",
               "Days": [
                  {
                     "ID": "P1.C1.D1",
                     "IDType": "VISIT",
                     "Description": null,
                     "ActivityDateTime": null,
                     "EarliestDateTime": null,
                     "LatestDateTime": null,
                     "Procedures": [
                        {
                           "Code": "77416",
                           "CodeSet": "PROC",
                           "Description": "Chest XRay",
                           "Modifiers": []
                        }
                     ]
                  }
               ]
            }
         ]
      }
   ]
}