Create Organization

Registers your Organization in Metriport.

POST /medical/v1/organization

Create Organization

cURL

curl --request POST \
  --url https://api.sandbox.metriport.com/medical/v1/organization \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "type": "<string>",
  "location": {
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>"
  }
}
'

import requests

url = "https://api.sandbox.metriport.com/medical/v1/organization"

payload = {
    "name": "<string>",
    "type": "<string>",
    "location": {
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>",
        "country": "<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({
    name: '<string>',
    type: '<string>',
    location: {
      addressLine1: '<string>',
      addressLine2: '<string>',
      city: '<string>',
      state: '<string>',
      zip: '<string>',
      country: '<string>'
    }
  })
};

fetch('https://api.sandbox.metriport.com/medical/v1/organization', 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/organization",
  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([
    'name' => '<string>',
    'type' => '<string>',
    'location' => [
        'addressLine1' => '<string>',
        'addressLine2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'zip' => '<string>',
        'country' => '<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/organization"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"location\": {\n    \"addressLine1\": \"<string>\",\n    \"addressLine2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"country\": \"<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/organization")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"location\": {\n    \"addressLine1\": \"<string>\",\n    \"addressLine2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"country\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.metriport.com/medical/v1/organization")

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  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"location\": {\n    \"addressLine1\": \"<string>\",\n    \"addressLine2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\",\n    \"country\": \"<string>\"\n  }\n}"

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

Metriport SDK

import { Metriport, OrgType, USState } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const org = await metriport.createOrganization({
  type: OrgType.postAcuteCare,
  name: "Metriport Inc.",
  location: {
    addressLine1: "2261 Market Street",
    addressLine2: "#4818",
    city: "San Francisco",
    state: USState.CA,
    zip: "94114",
    country: "USA",
  }
});

Body

name · string · required

The name of your organization. This is usually your legal corporate entity name - for example Metriport Inc..

type · string · required

The type of your organization, can be one of: acuteCare, ambulatory, hospital, labSystems, pharmacy, postAcuteCare.

location · Address · required

Show Address 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

If specified, must be "USA"; otherwise will default to "USA".

Response

id · string · required

The ID assigned to your organization. This ID will be used to uniquely identify your organization in medical documents.

oid · string · required

The OID assigned to this Organization.

name · string · required

The name of your organization. This is usually your legal corporate entity name - for example Metriport Inc..

type · string · required

The type of your organization, can be one of: acuteCare, ambulatory, hospital, labSystems, pharmacy, postAcuteCare.

location · 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".

Metriport SDK

import { Metriport, OrgType, USState } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const org = await metriport.createOrganization({
  type: OrgType.postAcuteCare,
  name: "Metriport Inc.",
  location: {
    addressLine1: "2261 Market Street",
    addressLine2: "#4818",
    city: "San Francisco",
    state: USState.CA,
    zip: "94114",
    country: "USA",
  }
});

{
    "id": "018a80c4-292a-7486-a1234-7uwe234ert90",
    "oid": "2.16.840.1.113883.3.666.123",
    "type": "postAcuteCare",
    "name": "Metriport Inc.",
    "location": {
      "addressLine1": "2261 Market Street",
      "addressLine2": "#4818",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94114",
      "country": "USA"
    }
}