Deactivate

Description

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

API endpoints for Provider Deactivate

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

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

Data Model JSON for Deactivate

Deactivate - Sample Payload

{
   "Meta": {
      "DataModel": "Provider",
      "EventType": "Deactivate",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "c3d7754e-7ba2-49ea-87bb-f94b1490cfce ",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "ba95778f-5e81-4ca8-8997-a223f5285f39",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "9f31763b-d690-47d0-adf4-56f7e6b0c8d4",
            "AttemptID": "74174274-3e66-4e12-8dfb-0f07f47f9cbb"
         }
      ],
      "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 Main St.",
                  "City": "San Jose"",
                  "State": "CA",
                  "ZIP": "53703",
                  "County": "Santa Clara",
                  "Country": "USA"
               }
            ],
            "EmailAddresses": [
               "john.marker@ehrbridge.com"
            ],
            "PhoneNumber": {
               "Home": "+16087851235",
               "Office": "+16089851234",
               "Mobile": "+16083451236"
            },
            "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"
                  }
               ]
            }
         ]
      }
   ]
}