Returns a patient by ID - Scan.com API Documentation

Returns a patient by ID

curl --request GET \
  --url https://api.staging.scan.com/api/v2/patients/{id} \
  --header 'Authorization: Bearer <token>'

require 'uri'
require 'net/http'

url = URI("https://api.staging.scan.com/api/v2/patients/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.staging.scan.com/api/v2/patients/{id}', 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.staging.scan.com/api/v2/patients/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.staging.scan.com/api/v2/patients/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "id": "11111111-1111-1111-1111-111111111111",
  "first_name": "John",
  "middle_initial": "D",
  "last_name": "Doe",
  "email": "[email protected]",
  "phone_number": "+1234567890",
  "date_of_birth": "05/21/1988",
  "date_of_birth_iso": "1988-05-21",
  "identifier": {
    "system": "https://scan.com/fhir/sid/patient-id",
    "value": "11111111-1111-1111-1111-111111111111"
  },
  "address_line_1": "123 Main St",
  "address_line_2": "",
  "city": "New York",
  "state": "NY",
  "zip_code": "10001",
  "gender": "male",
  "weight": 150,
  "height_feet": 5,
  "height_inches": 10
}

GET

/

api

/

v2

/

patients

/

{id}

Returns a patient by ID

curl --request GET \
  --url https://api.staging.scan.com/api/v2/patients/{id} \
  --header 'Authorization: Bearer <token>'

require 'uri'
require 'net/http'

url = URI("https://api.staging.scan.com/api/v2/patients/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.staging.scan.com/api/v2/patients/{id}', 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.staging.scan.com/api/v2/patients/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.staging.scan.com/api/v2/patients/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "id": "11111111-1111-1111-1111-111111111111",
  "first_name": "John",
  "middle_initial": "D",
  "last_name": "Doe",
  "email": "[email protected]",
  "phone_number": "+1234567890",
  "date_of_birth": "05/21/1988",
  "date_of_birth_iso": "1988-05-21",
  "identifier": {
    "system": "https://scan.com/fhir/sid/patient-id",
    "value": "11111111-1111-1111-1111-111111111111"
  },
  "address_line_1": "123 Main St",
  "address_line_2": "",
  "city": "New York",
  "state": "NY",
  "zip_code": "10001",
  "gender": "male",
  "weight": 150,
  "height_feet": 5,
  "height_inches": 10
}

Authorizations

Authorization

string

header

required

Authorization: Bearer <api_token>. Sandbox tokens come from Get API keys and allow 2,000 successful requests or 7 days. Failed 4xx/5xx responses do not consume the allowance. Production tokens are issued from the group's API access tab.

Path Parameters

id

string

required

Patient ID

Response

patient

id

string<uuid>

Unique patient identifier

first_name

string

Patient first name

middle_initial

string

Patient middle initial

last_name

string

Patient last name

email

string<email>

Patient email address

phone_number

string

Patient phone number

date_of_birth

string

Patient date of birth (MM/DD/YYYY)

address_line_1

string

Primary address line

address_line_2

string

Secondary address line (optional)

city

string

City

state

string

State abbreviation

zip_code

string

ZIP code

gender

enum<string>

Patient gender

Available options:

male,

female,

other

weight

integer

Patient weight in pounds

height_feet

integer

Height in feet

height_inches

integer

Additional height in inches