Set Patient Facilities

Sets the facilities associated with a patient. This operation overrides any existing facility associations and replaces them with the provided list.

POST /medical/v1/patient/{id}/facility

Set Patient Facilities

cURL

curl --request POST \
  --url https://api.sandbox.metriport.com/medical/v1/patient/{id}/facility \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "facilityIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.sandbox.metriport.com/medical/v1/patient/{id}/facility"

payload = { "facilityIds": ["<string>"] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({facilityIds: ['<string>']})
};

fetch('https://api.sandbox.metriport.com/medical/v1/patient/{id}/facility', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.metriport.com/medical/v1/patient/{id}/facility",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'facilityIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.metriport.com/medical/v1/patient/{id}/facility"

	payload := strings.NewReader("{\n  \"facilityIds\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.metriport.com/medical/v1/patient/{id}/facility")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"facilityIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.metriport.com/medical/v1/patient/{id}/facility")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"facilityIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

Metriport SDK

import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const patientId = "018a80c4-292a-7486-a1234-76yuhe23yu14";
const facilities = await metriport.setPatientFacilities(
  patientId,
  [
    "018a80c4-292a-7486-a1234-9uiu76yhe234",
    "018a80c4-292a-7486-a1234-6hyt345tyu23",
  ]
);

Path Params

id · string · required

The ID of the patient to set facilities for.

Body

facilityIds · string[] · required

Array of facility IDs to associate with the patient. This will replace all existing facility associations.

Response

facilities · Facility[] · required

Array of facilities associated with the patient after the update.

Show Facility properties

id · string · required

The ID assigned to this Facility. This ID will be used to uniquely identify this Facility in medical documents.

oid · string · required

The OID assigned to this Facility.

name · string · required

The name of your Facility. This is the actual address where a patient will receive care (can be virtual) - for example Care Facility, LLC.

npi · string · required

The 10 digit National Provider Identifier (NPI) that will be used to make requests on behalf of the Facility.

address · Address · required

Show properties

addressLine1 · string · required

The address.

addressLine2 · string

The address details, for example: #4451.

city · string · required

The city.

state · string · required

The 2 letter state acronym, for example: CA.

zip · string · required

5 digit zip code.

country · string · required

Must be "USA".

tin · string

The Taxpayer Identification Number (TIN) of the Facility.

active · bool

Whether or not this Facility is currently active - this is usually true.

Metriport SDK

import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const patientId = "018a80c4-292a-7486-a1234-76yuhe23yu14";
const facilities = await metriport.setPatientFacilities(
  patientId,
  [
    "018a80c4-292a-7486-a1234-9uiu76yhe234",
    "018a80c4-292a-7486-a1234-6hyt345tyu23",
  ]
);

{
  "facilities": [
    {
      "id": "018a80c4-292a-7486-a1234-9uiu76yhe234",
      "eTag": "1",
      "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",
      "eTag": "1",
      "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"
      }
    }
  ]
}