New

Description

The New event is deprecated in favor of the Administration event.

API endpoints for New

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

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

Data Model JSON for New

New - Sample Payload

{
   "Meta": {
      "DataModel": "Vaccination",
      "EventType": "New",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "31f36d98-6f57-430e-82b3-470858c8fd9f",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "5a5a65d8-84a5-4ece-93c2-15f06ed5404e",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "8c443065-d79b-4ace-8f16-fa5e71671b83 ",
            "AttemptID": "37d4e3f5-eefb-49c5-bca4-eef6b981dc53"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "ab01b534-2114-4099-a097-c295bbe34592",
            "IDType": "EHRID"
         },
         {
            "ID": "33581cd9-2df4-45d0-9831-e4ff5de6da7a",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "James",
         "MiddleName": "Alex",
         "LastName": "Smith",
         "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": "4762 Hill Street",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": [],
      "Contacts": [
         {
            "FirstName": "Alena",
            "MiddleName": null,
            "LastName": "Smith",
            "Address": {
               "StreetAddress": "4762 Hill Street",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "53566",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "PhoneNumber": {
               "Home": "+18086775303",
               "Office": "+17078543758",
               "Mobile": "+19187868865"
            },
            "RelationToPatient": "Mother",
            "EmailAddresses": [
               "alena.smith@test.net"
            ],
            "Roles": [
               "Emergency Contact"
            ]
         }
      ],
      "Consent": {
         "Status": null,
         "EffectiveDate": null,
         "Notification": null
      }
   },
   "Visit": {
      "VisitNumber": "98765",
      "AccountNumber": null
   },
   "Vaccinations": [
      {
         "DateTime": "2015-08-13T21:08:57.581Z",
         "Product": {
            "Code": "20",
            "Codeset": "CVX",
            "Description": null,
            "LotNumber": "123456789",
            "ExpirationDate": null,
            "Manufacturer": {
               "Code": null,
               "Codeset": null,
               "Name": null
            }
         },
         "Route": {
            "Code": "Intramuscular",
            "Codeset": null,
            "Name": null
         },
         "Site": {
            "Code": "Left arm",
            "Codeset": null,
            "Name": null
         },
         "Dose": {
            "Quantity": "0.5",
            "Units": null
         },
         "Order": {
            "ID": "123",
            "EHRID": "456",
            "Provider": {
               "NPI": null,
               "ID": null,
               "IDType": null,
               "FirstName": null,
               "LastName": null,
               "Credentials": [],
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               },
               "EmailAddresses": [],
               "PhoneNumber": {
                  "Office": null
               },
               "Location": {
                  "Type": null,
                  "Facility": null,
                  "Department": null,
                  "Room": null
               }
            }
         },
         "ClinicalInfo": [],
         "Notes": [
            "VIS date: May 17 2007"
         ],
         "RefusalReason": null,
         "Provider": {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Bobby",
            "LastName": "Grant",
            "Credentials": [],
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": null
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         },
         "Location": {
            "Type": "Clinic",
            "Facility": "Rolling Oaks Outpatient Center",
            "Department": "Rolling Oaks Pediatrics",
            "Room": null
         }
      }
   ]
}