Metriport home pagelight logo
  1. Link
  2. Create Link
POST

/medical/v1/patient/{id}/link/{linkSource}

x-api-key*
curl --request POST \
     --url https://api.metriport.com/medical/v1/patient/{id}/link/{linkSource} \
     --header 'x-api-key: AUTH_VALUE' \
     --header 'Content-Type: application/json' \
     --data '{
 "entityId": "string"
}'

​
Path Params

idRequired
string

The ID of the Patient that will be linked to the entity in the HIE.

linkSourceRequired
string

The HIE to link to - currently COMMONWELL is supported.

​
Query Params

facilityIdRequired
string

The ID of the Facility that is currently providing the Patient care.

​
Body

entityIdRequired
string

The ID of the entity in the HIE to link the Patient to.

​
Response

201 on success.

import { Metriport } from "@metriport/api";

const metriportClient = new MetriportMedicalApi("YOUR_API_KEY");

await metriportClient.createLink(
  "2.16.840.1.113883.3.666.777",
  "2.16.840.1.113883.3.666.123",
  "1.23.1234.123.3333",
  "COMMONWELL"
);