Skip to main content
POST
Register a facility

Authorizations

X-API-Key
string
header
required

Body

application/json

Register a new healthcare facility.

ccn
string
required

6-digit Medicare Provider Number (CCN)

Pattern: ^\d{6}$
Example:

"170001"

name
string
required

Facility display name

Required string length: 1 - 255
Example:

"Acme General Hospital"

address_line1
string | null

Street address line 1

Maximum string length: 255
address_line2
string | null

Street address line 2

Maximum string length: 255
cbsa
string | null

Core Based Statistical Area code (auto-derived if omitted)

Maximum string length: 10
certifications
string[] | null

Facility licensures/certifications that can drive payer rules, e.g. ['oasas_licensed', 'omh_licensed'].

Example:
city
string | null

City

Maximum string length: 100
Example:

"Topeka"

county
string | null

County name

Maximum string length: 100
Example:

"Shawnee"

facility_type
string | null

Facility type — short_term_acute, asc, rhc, fqhc, ipf, irf, ltch, etc. Drives the facility/non-facility PE-RVU choice.

Maximum string length: 64
is_rural
boolean | null

Pre-computed CMS rural indicator. Drives DME rural/non-rural rate selection.

npi
string | null

10-digit National Provider Identifier

Pattern: ^\d{10}$
Example:

"1234567890"

pos_code
string | null

Default place-of-service code (e.g. '11' office, '22' on-campus outpatient hospital)

Pattern: ^\d{2}$
state
string | null

2-letter state code

Pattern: ^[A-Z]{2}$
Example:

"KS"

zip_code
string | null

ZIP code

Pattern: ^\d{5}(-\d{4})?$
Example:

"66601"

Response

Created facility profile

Facility profile with resolved knowledge layers.

ccn
string
required

Medicare Provider Number

created_at
string<date-time>
required
id
string<uuid>
required
is_active
boolean
required
name
string
required

Facility display name

address_line1
string | null
cbsa
string | null

Core Based Statistical Area code

cbsa_detail
CBSADetail · object | null

CBSA metro area detail

certifications
string[] | null

Facility licensures/certifications that can drive payer rules.

city
string | null
county
string | null
facility_type
string | null

short_term_acute, asc, rhc, fqhc, ipf, ...

gpci
GPCIDetail · object | null

GPCI locality factors

is_rural
boolean | null

CMS rural indicator (DME rate selection)

mac
MACDetail · object | null

Medicare Administrative Contractor

npi
string | null

National Provider Identifier

pos_code
string | null

Default place-of-service code

resolved_layers
Resolved Layers · object

Cached L1-L6 knowledge layer data

state
string | null
zip_code
string | null