JOjoincandidhealth
v2

Get organization service facility by external_id

Changed on

Looks up a single organization service facility by its external_id field. This can be useful for finding service facilities within Candid which are associated with service facilities in an external system.

get/api/organization-service-facilities/v2/external-id/{external_id}

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/organization-service-facilities/v2/external-id/{external_id}
  • Auth
    HTTP bearer

Path parameters

external_idstring required

Response

Response with status 200

organization_service_facility_idstring uuid required
namestring required

The name of the service facility.

aliasesstring[] required

A list of alternate names for the service facility.

descriptionstring

A description of the service facility.

external_idstring

An ID for this service facility used in an external system (e.g. your EMR). Service facilities can be queried by this field.

npistring

An NPI specific to the service facility if applicable, i.e. if it has one and is not under the billing provider's NPI. Box 32 section (a) of the CMS-1500 claim form.

place_of_service_code'01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '12' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '31' | '32' | '33' | '34' | '41' | '42' | '49' | '50' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '58' | '60' | '61' | '62' | '65' | '71' | '72' | '81' | '99'

Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 02 for telemedicine, 11 for in-person. Full list here: https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set

clia_numberstring

The associated CLIA number with this service facility. Can be used to populate CLIA numbers on encounters.

mammography_certification_numberstring

The associated mammography certification number for this service facility. This is a 6 digit code assigned by the FDA.

status'active' | 'inactive' | 'suspended'
operational_status'C' | 'H' | 'I' | 'K' | 'O' | 'U'
mode'instance' | 'kind'
type'DX' | 'CVDX' | 'CATH' | 'ECHO' | 'GIDX' | 'ENDOS' | 'RADDX' | 'RADO' | 'RNEU' | 'HOSP' | 'CHR' | 'GACH' | 'MHSP' | 'PSYCHF' | 'RH' | 'RHAT' | 'RHII' | 'RHMAD' | 'RHPI' | 'RHPIH' | 'RHPIMS' | 'RHPIVS' | 'RHYAD' | 'HU' | 'BMTU' | 'CCU' | 'CHEST' | 'EPIL' | 'ER' | 'ETU' | 'HD' | 'HLAB' | 'INLAB' | 'OUTLAB' | 'HRAD' | 'HUSCS' | 'ICU' | 'PEDICU' | 'PEDNICU' | 'INPHARM' | 'MBL' | 'NCCS' | 'NS' | 'OUTPHARM' | 'PEDU' | 'PHU' | 'RHU' | 'SLEEP' | 'NCCF' | 'SNF' | 'OF' | 'ALL' | 'AMPUT' | 'BMTC' | 'BREAST' | 'CANC' | 'CAPC' | 'CARD' | 'PEDCARD' | 'COAG' | 'CRS' | 'DERM' | 'ENDO' | 'PEDE' | 'ENT' | 'FMC' | 'GI' | 'PEDGI' | 'GIM' | 'GYN' | 'HEM' | 'PEDHEM' | 'HTN' | 'IEC' | 'INFD' | 'PEDID' | 'INV' | 'LYMPH' | 'MGEN' | 'NEPH' | 'PEDNEPH' | 'NEUR' | 'OB' | 'OMS' | 'ONCL' | 'PEDHO' | 'OPH' | 'OPTC' | 'ORTHO' | 'HAND' | 'PAINCL' | 'PC' | 'PEDC' | 'PEDRHEUM' | 'POD' | 'PREV' | 'PROCTO' | 'PROFF' | 'PROS' | 'PSI' | 'PSY' | 'RHEUM' | 'SPMED' | 'SU' | 'PLS' | 'URO' | 'TR' | 'TRAVEL' | 'WND' | 'RTF' | 'PRC' | 'SURF' | 'DADDR' | 'MOBL' | 'AMB' | 'PHARM' | 'ACC' | 'COMM' | 'CSC' | 'PTRES' | 'SCHOOL' | 'UPC' | 'WORK'
physical_type'si' | 'bu' | 'wi' | 'wa' | 'lvl' | 'co' | 'ro' | 'bd' | 've' | 'ho' | 'ca' | 'rd' | 'area' | 'jdn'
telecomsstring[] required

A list of contact methods for the service facility.

Changes

  • 24b2d80d577aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id get_by_external_id removed and replaced with v2_get_by_external_id