Get Facility

GET 
/api/v2/public/facilities/:facilityId

Return a single facility data based on the facilityId path param, you'll only be able to fetch the facility's data if you have a Facility Connection in place.

Request

Path Parameters

facilityId stringrequired
Id of the facility
Example: NUR-12345

Responses

201

application/json

Schema

Schema

data object

facilityId stringrequired

Nursa id of the facility

name stringrequired

Name of the facility

type stringrequired

Type of the facility

category stringrequired

Category of the facility

numberOfBeds numberrequired

Possible values: <= 999

Number of beds in the facility

streetAddress stringrequired

Street address of the facility

cityName stringrequired

Name of the city where the facility is located

zipCode ##### | #####-####required

Zip code of the facility

stateCode stringrequired

State Abbreviation of the facility in ANSI standard

county stringrequired

Name of the county where the facility is located

contactPhone +1##########required

Telephone number of the facility

billingInformation objectrequired

contactName stringrequired

Name of the contact

contactEmail stringrequired

Email of the contact

contactPhone +1##########required

Telephone number of the contact

specialty object[]required

Data related to the facility specialty

Array [

title stringrequired

Title of the specialty

description stringrequired

Description of the Specialty

]

websiteUrl string

Website URL of the facility

healthCareSystem string

Healthcare System of the facility

Example (from schema)

{
  "data": {
    "facilityId": "124345",
    "name": "Facility name",
    "type": "Freestanding Hospice",
    "category": "Hospice",
    "numberOfBeds": 10,
    "streetAddress": "Idaho address",
    "cityName": "Hayden",
    "zipCode": "83835",
    "stateCode": "ID",
    "county": "Idaho County",
    "contactPhone": "+12345678910",
    "billingInformation": {
      "contactName": "John Doe",
      "contactEmail": "john.doe@email.com",
      "contactPhone": "+11234567890"
    },
    "specialty": [
      {
        "title": "Intensive Care Unit",
        "description": "Intensive Care Unit"
      }
    ],
    "websiteUrl": "https://example.com",
    "healthCareSystem": "string"
  }
}

400

Bad request

application/json

Schema

Schema

message string[]

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": [
    "Property must be a string"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

Request Validation

Request Validation Error

{
  "message": [
    "facilityId must be a string"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

401

Unauthorized

application/json

Schema

Schema

message string

Error description

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Unauthorized",
  "statusCode": 401
}

403

Forbidden

application/json

Schema

Schema

message string

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Forbidden Resource",
  "error": "Forbidden",
  "statusCode": 403
}

404

Not Found

application/json

Schema

Schema

message string

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Not Found",
  "error": "Not Found",
  "statusCode": 404
}

Not Found

Facility was not found

{
  "message": "Facility not found",
  "error": "Not Found",
  "statusCode": 404
}

Loading...