Activate

Description

An Activate message is used to convey that a provider's status has changed from Inactive to Active. This message is typically used to notify recipient systems or applications that a provider who was previously marked as inactive or disabled is now active and available for clinical or administrative activities.

API endpoints for Provider Activate

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

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

Data Model JSON for Activate

Activate - Sample Payload

{
   "Meta": {
      "DataModel": "Provider",
      "EventType": "Activate",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "39434441-06f1-4a83-a448-ce8614049f34",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "98ad0575-1349-4869-930f-b212061f486f",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "5d574a8f-100b-4a9c-9837-60e86a3757cd",
            "AttemptID": "bf141a38-f7c8-4721-98c2-a69e19444b87"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Providers": [
      {
         "Identifiers": [
            {
               "ID": "4356789876",
               "IDType": "NPI"
            }
         ],
         "Demographics": {
            "FirstName": "John",
            "LastName": "F",
            "MiddleName": "Marker",
            "Credentials": [
               "MD"
            ],
            "Addresses": [
               {
                  "Use": "Office",
                  "StreetAddress": "123 High St.",
                  "City": "San Jose"",
                  "State": "CA",
                  "ZIP": "53703",
                  "County": "Santa Clara",
                  "Country": "USA"
               }
            ],
            "EmailAddresses": [
               "john.marker@ehrbridge.com"
            ],
            "PhoneNumber": {
               "Home": "+16895551235",
               "Office": "+16080951234",
               "Mobile": "+160855512326"
            },
            "Sex": "Male",
            "DOB": "1963-01-06",
            "Languages": [
               "English",
               "Spanish"
            ]
         },
         "Qualifications": [
            {
               "Identifiers": [
                  {
                     "ID": "5421",
                     "IDType": null
                  }
               ],
               "Code": "MD",
               "Codeset": "http://hl7.org/fhir/v2/0360/2.7",
               "Description": "Doctor of Medicine",
               "StartDate": "2000-02-01",
               "EndDate": null
            }
         ],
         "Roles": [
            {
               "Identifiers": [
                  {
                     "ID": "12",
                     "IDType": null
                  }
               ],
               "Organization": {
                  "Identifiers": [
                     {
                        "ID": "135",
                        "IDType": null
                     }
                  ],
                  "IsActive": true,
                  "Type": "Provider",
                  "Name": "City Care Clinic",
                  "Address": {
                     "StreetAddress": "123 Main St.",
                     "City": "San Jose"",
                     "State": "CA",
                     "ZIP": "53703",
                     "County": "Santa Clara",
                     "Country": "USA"
                  }
               },
               "Specialties": [
                  {
                     "Code": "394802001",
                     "Codeset": "SnomedCT",
                     "Description": "General Medicine"
                  }
               ],
               "Locations": [
                  {
                     "Identifiers": [
                        {
                           "ID": "123354",
                           "IDType": null
                        }
                     ],
                     "Status": "active",
                     "Name": "City Care Clinic",
                     "Description": null,
                     "Address": {
                        "StreetAddress": "123 Main St",
                        "City": "San Jose"",
                        "State": "CA",
                        "ZIP": "53703",
                        "County": "Santa Clara",
                        "Country": "USA"
                     },
                     "EmailAddresses": [],
                     "PhoneNumber": {
                        "Office": "+16084455673"
                     }
                  }
               ],
               "Services": [
                  {
                     "Identifiers": [
                        {
                           "ID": "60",
                           "IDType": null
                        }
                     ],
                     "Type": "Nutrition",
                     "Description": "Nutrition",
                     "PhoneNumber": {
                        "Office": "+16083334985"
                     }
                  }
               ],
               "Availability": [
                  {
                     "Days": [
                        "Monday",
                        "Tuesday"
                     ],
                     "AvailableStartTime": "09:00",
                     "AvailableEndTime": "17:00"
                  }
               ]
            }
         ]
      }
   ]
}