PractitionerRoles

The PractitionerRoles file contains information about practitionerRole entities, which link together practitioners, locations and the health plans that they accept using the respective identifiers (practitionerId, locationId, planId) for those entities.

Filename format

practitionerroles_##.json

JSON schema

JSON schema for PractitionerRoles file

{
    "$schema": "https://json-schema.org/draft/2019-09/schema",
    "$id": "https://defacto.health/insurances/practitionerroles.schema.json",
    "title": "Healthcare locations",
    "description": "The link between practitioners, locations and health plans.",
    "type": "object",
    "properties":
    {
        "practitionerRoles":
        {
            "type": "array",
            "description": "Array of all practitionerRole entities collected by Defacto Health",
            "items":
            {
                "type": "object",
                "properties":
                {
                    "practitionerId": {
                        "type": "integer",
                        "description": "Defacto Health generated identifier for the practitioner, unique across all practitioners."
                    },
                    "locationId": {
                        "type": "integer",
                        "description": "Defacto Health generated identifier for the location, unique across all locations."
                    },
                    "organizationId": {
                        "type": "integer",
                        "description": "Defacto Health generated identifier for the organization, unique across all organizations."
                    },
                    "phoneNumbers": {
                        "type": "array",
                        "description": "Array of phone numbers for the practitioner; phone numbers are digits only, with no formatting or spaces."
                    },
                    "planIds": {
                        "type": "array",
                        "description": "Array of Defacto Health generated identifiers for the health plans accepted by this practitioner, unique across all plans across all carriers."
                    }
                },
                "required":
                [
                    "practitionerId",
                    "locationId",
                    "planIds"
                ]
            }
        }
    }
}

Sample JSON

Sample JSON for PractitionerRoles file

{
    "practitionerRoles":
    [
        {
            "practitionerId": 34,
            "locationId": 56,
            "organizationId": 64,
            "phoneNumbers": ["2126852058"],
            "planIds": [76, 842]
        },
        {
            "practitionerId": 88,
            "locationId": 346,
            "organizationId": 43,
            "phoneNumbers": ["4125322042"],
            "planIds": [5, 786, 3467]
        }
    ]
}

Attributes

Attribute	Type	Description	Required	Constraints	Example
practitionerId	integer	Defacto Health generated identifier for the practitioner, unique across all practitioners.	yes	Must be present in Practitioners file	34
locationId	integer	Defacto Health generated identifier for the location, unique across all locations.	no	Must be present in Locations file	56
organizationId	integer	Defacto Health generated identifier for the organization, unique across all organizations.	no	Must be present in Organizations file	34
phoneNumbers	array[string]	Array of phone numbers for the practitioner; phone numbers are digits only, with no formatting or spaces.	no		["2126852058"]
planIds	array[integer]	Defacto Health generated identifier for the health plan, unique across all plans across all carriers.	yes	Must be present in CarrierPlans file	[45,76]