SubjectUpdate

Description

The SubjectUpdate event can be used to associate a patient with a clinical study. An EHR may allow users to mark patients as candidates for a study, and this event would be communicated to the trial management system. The trial management system may then confirm the status of the patient, which will be sent back to the EHR.

API endpoints for Research Subject Update

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

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

Data Model JSON for SubjectUpdate

SubjectUpdate - Sample Payload

{
   "Meta": {
      "DataModel": "Research",
      "EventType": "SubjectUpdate",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "2d374f77-e629-488a-8045-175fe2ea4edd ",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "65eb87df-d6af-4d15-8865-b07674576e84",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "1b0dd767-f3ae-4eb5-8d54-e92fc061c875",
            "AttemptID": "53c2bc01-dd65-4034-8995-057418c2344b"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Enrollment": {
      "SubjectStatus": "active",
      "StartDateTime": "1906-12-10T00:00:00.000Z",
      "EndDateTime": null,
      "Coordinators": [
         {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Kevin",
            "LastName": "Adams",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "123 Main 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
            }
         },
         {
            "ID": "4236464757",
            "IDType": "NPI",
            "FirstName": "Albert ",
            "LastName": "Richard",
            "Credentials": [
               "DO"
            ],
            "Address": {
               "StreetAddress": "200 Wales St.",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "63105",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": "+13145554321"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         }
      ]
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "c9c70114-e1cc-4c8e-8c8f-b50198bce3a5",
            "IDType": "EHRID"
         },
         {
            "ID": "f1a6f7ce-e2a0-4c1c-8058-953556e47232",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "Mike",
         "MiddleName": "Barry",
         "LastName": "Wiley",
         "DOB": "2008-01-06",
         "SSN": "101-01-0001",
         "Sex": "Male",
         "Race": "White",
         "IsHispanic": null,
         "Religion": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18088675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "1234 Downtown Street",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": []
   },
   "Study": {
      "Identifiers": [
         {
            "ID": "2012P000957F",
            "IDType": "Org ID"
         },
         {
            "ID": "NCT02738255",
            "IDType": "NCT"
         }
      ],
      "Title": "Effect of Added Varnum Mouthpiece on Pharyngeal Collapsibility and Sleep Apnea Severity in Mouth Breathers.",
      "Type": "Interventional"
   }
}