Facility
Get Facility
Gets a Facility.
GET
/medical/v1/facility/{id}
x-api-key*
curl --request GET \
--url https://api.sandbox.metriport.com/medical/v1/facility/{id} \
--header 'x-api-key: <x-api-key>'
Path Params
idrequired
string
The ID of the Facility.
Response
idrequired
string
The ID assigned to this Facility. This ID will be used to uniquely identify this Facility in medical documents.
namerequired
string
The name of your Facility. This is the actual address where a patient will receive care (can be
virtual) - for example Care Facility, LLC
.
npirequired
string
The 10 digit National Provider Identifier (NPI) that will be used to make requests on behalf of the Facility.
addressrequired
Address
tin
string
The Taxpayer Identification Number (TIN) of the Facility.
active
bool
Whether or not this Facility is currently active - this is usually true
.
import { MetriportMedicalApi } from "@metriport/api-sdk";
const metriportClient = new MetriportMedicalApi("YOUR_API_KEY");
const facility = await metriportClient.getFacility("2.16.840.1.113883.3.666.123");
{
"id": "2.16.840.1.113883.3.666.123",
"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"
}
}
curl --request GET \
--url https://api.sandbox.metriport.com/medical/v1/facility/{id} \
--header 'x-api-key: <x-api-key>'
import { MetriportMedicalApi } from "@metriport/api-sdk";
const metriportClient = new MetriportMedicalApi("YOUR_API_KEY");
const facility = await metriportClient.getFacility("2.16.840.1.113883.3.666.123");