Facility
List Facilities
Getting Started
API Reference
- Facility
- Patient
- Document
- FHIR
FHIR
- FHIR Overview
- Data Types
- Resources
- Extensions
Facility
List Facilities
Lists all of your Facilities.
GET
/
medical
/
v1
/
facility
x-api-key
string
*
x-api-key
Required
string
Response
Array of all of the Facilities created under your Organization.
The ID assigned to this Facility. This ID will be used to uniquely identify this Facility in medical documents.
The OID assigned to this Facility.
The name of your Facility. This is the actual address where a patient will receive care (can be
virtual) - for example Care Facility, LLC
.
The 10 digit National Provider Identifier (NPI) that will be used to make requests on behalf of the Facility.
The Taxpayer Identification Number (TIN) of the Facility.
Whether or not this Facility is currently active - this is usually true
.
{
"facilities":[
{
"id": "018a80c4-292a-7486-a1234-9uiu76yhe234",
"oid": "2.16.840.1.113883.3.666.123.4.101",
"name": "Care Facility, LLC",
"npi": "1234567891",
"tin": "12-3456789",
"active": true,
"address": {
"addressLine1": "2261 Market Street",
"addressLine2": "#4818",
"city": "San Francisco",
"state": "CA",
"zip": "94114",
"country": "USA"
}
},
{
"id": "018a80c4-292a-7486-a1234-6hyt345tyu23",
"oid": "2.16.840.1.113883.3.666.123.4.102",
"name": "Care Facility 2, LLC",
"npi": "1789123456",
"tin": "12-6789345",
"active": true,
"address": {
"addressLine1": "451 Care Street",
"addressLine2": "#320",
"city": "Austin",
"state": "TX",
"zip": "78617",
"country": "USA"
}
}
]
}