IHI Precheck

POST

organizations

{organization_id}

users

{user_id}

patients

ihi-precheck

IHI Precheck

curl --request POST \
  --url https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/ihi-precheck \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-organization-secret: <x-organization-secret>' \
  --data '
{
  "partner_patient_id": "PMS-000123",
  "partner_id": "demo",
  "given_name": "Denice",
  "family_name": "SHEA",
  "date_of_birth": "1992-12-16",
  "sex": "F",
  "medicare_card_number": "6951907501",
  "medicare_irn": "1",
  "phone": "0417903853",
  "email": "919@Ausnet.com.au",
  "australian_street_address": {
    "street_number": "163",
    "street_name": "Law Rd",
    "suburb": "Jitarning",
    "state": "WA",
    "postcode": "6365"
  }
}
'

import requests

url = "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/ihi-precheck"

payload = {
    "partner_patient_id": "PMS-000123",
    "partner_id": "demo",
    "given_name": "Denice",
    "family_name": "SHEA",
    "date_of_birth": "1992-12-16",
    "sex": "F",
    "medicare_card_number": "6951907501",
    "medicare_irn": "1",
    "phone": "0417903853",
    "email": "919@Ausnet.com.au",
    "australian_street_address": {
        "street_number": "163",
        "street_name": "Law Rd",
        "suburb": "Jitarning",
        "state": "WA",
        "postcode": "6365"
    }
}
headers = {
    "x-organization-secret": "<x-organization-secret>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-organization-secret': '<x-organization-secret>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    partner_patient_id: 'PMS-000123',
    partner_id: 'demo',
    given_name: 'Denice',
    family_name: 'SHEA',
    date_of_birth: '1992-12-16',
    sex: 'F',
    medicare_card_number: '6951907501',
    medicare_irn: '1',
    phone: '0417903853',
    email: '919@Ausnet.com.au',
    australian_street_address: {
      street_number: '163',
      street_name: 'Law Rd',
      suburb: 'Jitarning',
      state: 'WA',
      postcode: '6365'
    }
  })
};

fetch('https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/ihi-precheck', 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.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/ihi-precheck",
  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([
    'partner_patient_id' => 'PMS-000123',
    'partner_id' => 'demo',
    'given_name' => 'Denice',
    'family_name' => 'SHEA',
    'date_of_birth' => '1992-12-16',
    'sex' => 'F',
    'medicare_card_number' => '6951907501',
    'medicare_irn' => '1',
    'phone' => '0417903853',
    'email' => '919@Ausnet.com.au',
    'australian_street_address' => [
        'street_number' => '163',
        'street_name' => 'Law Rd',
        'suburb' => 'Jitarning',
        'state' => 'WA',
        'postcode' => '6365'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-organization-secret: <x-organization-secret>"
  ],
]);

$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.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/ihi-precheck"

	payload := strings.NewReader("{\n  \"partner_patient_id\": \"PMS-000123\",\n  \"partner_id\": \"demo\",\n  \"given_name\": \"Denice\",\n  \"family_name\": \"SHEA\",\n  \"date_of_birth\": \"1992-12-16\",\n  \"sex\": \"F\",\n  \"medicare_card_number\": \"6951907501\",\n  \"medicare_irn\": \"1\",\n  \"phone\": \"0417903853\",\n  \"email\": \"919@Ausnet.com.au\",\n  \"australian_street_address\": {\n    \"street_number\": \"163\",\n    \"street_name\": \"Law Rd\",\n    \"suburb\": \"Jitarning\",\n    \"state\": \"WA\",\n    \"postcode\": \"6365\"\n  }\n}")

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

	req.Header.Add("x-organization-secret", "<x-organization-secret>")
	req.Header.Add("Authorization", "Bearer <token>")
	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.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/ihi-precheck")
  .header("x-organization-secret", "<x-organization-secret>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"partner_patient_id\": \"PMS-000123\",\n  \"partner_id\": \"demo\",\n  \"given_name\": \"Denice\",\n  \"family_name\": \"SHEA\",\n  \"date_of_birth\": \"1992-12-16\",\n  \"sex\": \"F\",\n  \"medicare_card_number\": \"6951907501\",\n  \"medicare_irn\": \"1\",\n  \"phone\": \"0417903853\",\n  \"email\": \"919@Ausnet.com.au\",\n  \"australian_street_address\": {\n    \"street_number\": \"163\",\n    \"street_name\": \"Law Rd\",\n    \"suburb\": \"Jitarning\",\n    \"state\": \"WA\",\n    \"postcode\": \"6365\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/ihi-precheck")

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

request = Net::HTTP::Post.new(url)
request["x-organization-secret"] = '<x-organization-secret>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"partner_patient_id\": \"PMS-000123\",\n  \"partner_id\": \"demo\",\n  \"given_name\": \"Denice\",\n  \"family_name\": \"SHEA\",\n  \"date_of_birth\": \"1992-12-16\",\n  \"sex\": \"F\",\n  \"medicare_card_number\": \"6951907501\",\n  \"medicare_irn\": \"1\",\n  \"phone\": \"0417903853\",\n  \"email\": \"919@Ausnet.com.au\",\n  \"australian_street_address\": {\n    \"street_number\": \"163\",\n    \"street_name\": \"Law Rd\",\n    \"suburb\": \"Jitarning\",\n    \"state\": \"WA\",\n    \"postcode\": \"6365\"\n  }\n}"

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

{
  "success": true,
  "statusCode": 200,
  "message": "IHI found using Medicare number",
  "code": "SUCCESS",
  "data": {
    "outcome": "ihi_found",
    "create_would_succeed": true,
    "ihi_check_passed": true,
    "searched_path": "medicare",
    "ihi_status": "ACTIVE",
    "ihi_record_status": "VERIFIED"
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123"
}

Overview

Checks whether patient data resolves a valid IHI before you create the patient. Send the same body as Create Patient. The precheck runs the same HI Service search as creation, creates nothing, and never returns the IHI number. Branch on data.outcome. Two flags answer the two common questions:

create_would_succeed — would an identical create request succeed right now?
ihi_check_passed — did the search resolve an ACTIVE + VERIFIED IHI (the prescribing bar)? Absent when no search ran.
message is a human-readable summary naming the identifier that matched. It is informational only.

Outcomes

`outcome`	Meaning	`create_would_succeed`	`ihi_check_passed`
`ihi_found`	The HI Service returned an IHI for this patient. Read `ihi_status` and `ihi_record_status` to see whether it is usable.	`true` when `ihi_record_status` is `VERIFIED`. `false` when it is `PROVISIONAL` or `UNVERIFIED`: creation is rejected until the record is verified.	`true` when `ihi_status` is `ACTIVE` and `ihi_record_status` is `VERIFIED`. `false` otherwise, for example a `VERIFIED` record whose status is `DECEASED` or `EXPIRED`.
`no_match`	Every identifier was tried; none matched. The patient is created without an IHI.	`true`	`false`
`insufficient_data`	No identifier to search on. `search_paths` lists what would unlock each path.	`false`, or `true` for Medicare without `medicare_irn`	absent
`already_exists`	A patient with this `partner_patient_id` exists. The live check still runs on the submitted data. Creation returns the existing patient.	`true`	live result, or absent if the check could not run
`organization_not_ready`	The organization has no HPI-O. Contact Parchment.	`false`	absent
`hi_service_error`	The HI Service is unreachable. Retry later.	`false`	absent

Search Paths

Every identifier you supply is tried in priority order until one matches. An identifier that returns no record falls back to the next. Supply every identifier you hold.

Priority	Path	Requires
1	`ihi_number`	`ihi_number`
2	`medicare`	`medicare_card_number` + `medicare_irn`
3	`dva`	`dva_file_number`
4	`mobile`	`phone` (Australian mobile)
5	`email`	`email`
6	`australian-street-address`	`australian_street_address`
7	`international-address`	`international_address`

All paths also require family_name, given_name, date_of_birth, sex. searched_path is the identifier that matched (or the last one tried on no_match). failed_paths lists the identifiers tried before it. It is absent when the first identifier matched.

Request Example

{
  "partner_patient_id": "PMS-000123",
  "partner_id": "demo",
  "given_name": "Denice",
  "family_name": "SHEA",
  "date_of_birth": "1992-12-16",
  "sex": "F",
  "medicare_card_number": "6951907501",
  "medicare_irn": "1",
  "phone": "0417903853",
  "email": "919@Ausnet.com.au",
  "australian_street_address": {
    "street_number": "163",
    "street_name": "Law Rd",
    "suburb": "Jitarning",
    "state": "WA",
    "postcode": "6365"
  }
}

Response Examples

IHI Found (200)

{
  "success": true,
  "statusCode": 200,
  "message": "IHI found using Medicare number",
  "code": "SUCCESS",
  "data": {
    "outcome": "ihi_found",
    "create_would_succeed": true,
    "ihi_check_passed": true,
    "searched_path": "medicare",
    "ihi_status": "ACTIVE",
    "ihi_record_status": "VERIFIED"
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123"
}

IHI Found After Fallback (200)

{
  "success": true,
  "statusCode": 200,
  "message": "IHI found using mobile number (no record found using Medicare number)",
  "code": "SUCCESS",
  "data": {
    "outcome": "ihi_found",
    "create_would_succeed": true,
    "ihi_check_passed": true,
    "searched_path": "mobile",
    "failed_paths": ["medicare"],
    "ihi_status": "ACTIVE",
    "ihi_record_status": "VERIFIED"
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123"
}

No Match (200)

{
  "success": true,
  "statusCode": 200,
  "message": "No IHI found using Medicare number, mobile number, Australian address",
  "code": "SUCCESS",
  "data": {
    "outcome": "no_match",
    "create_would_succeed": true,
    "ihi_check_passed": false,
    "searched_path": "australian-street-address",
    "failed_paths": ["medicare", "mobile"]
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123"
}

Insufficient Data (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Not enough identifiers to run an IHI search",
  "code": "SUCCESS",
  "data": {
    "outcome": "insufficient_data",
    "create_would_succeed": false,
    "search_paths": [
      { "path": "ihi_number", "missing": ["ihi_number"] },
      { "path": "medicare", "missing": ["medicare_card_number", "medicare_irn"] },
      { "path": "dva", "missing": ["dva_file_number"] },
      { "path": "mobile", "missing": ["phone"] },
      { "path": "email", "missing": ["email"] },
      { "path": "australian-street-address", "missing": ["australian_street_address"] },
      { "path": "international-address", "missing": ["international_address"] }
    ]
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123"
}

Patient Already Exists (200)

{
  "success": true,
  "statusCode": 200,
  "message": "Patient already exists; IHI check did not pass using Medicare number",
  "code": "SUCCESS",
  "data": {
    "outcome": "already_exists",
    "create_would_succeed": true,
    "ihi_check_passed": false,
    "searched_path": "medicare",
    "parchment_patient_id": "pat_abc123def456",
    "has_ihi": false
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123"
}

Validation Error (422)

Schema and identifier-format failures (Medicare checksum, IHI check digit, mobile, email, future date of birth) are reported together:

{
  "success": false,
  "statusCode": 422,
  "error": {
    "type": "https://parchment.health/errors/validation-error",
    "title": "Validation failed",
    "detail": "There were some problems with your input.",
    "validation": [
      { "field": "email", "message": "Invalid email address", "code": "VALIDATION_ERROR" },
      { "field": "medicare_card_number", "message": "Invalid Medicare number", "code": "VALIDATION_ERROR" }
    ]
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123"
}

Response Fields

Field	Type	Description
`outcome`	string	`ihi_found`, `no_match`, `insufficient_data`, `already_exists`, `organization_not_ready`, `hi_service_error`
`create_would_succeed`	boolean	Whether an identical create request would succeed now
`ihi_check_passed`	boolean	`true` only for an `ACTIVE` + `VERIFIED` IHI. Absent when no search ran
`searched_path`	string	Identifier that matched, or the last one tried on `no_match`
`failed_paths`	array	Identifiers tried before `searched_path`. Absent when the first matched
`ihi_status`	string	`ACTIVE`, `DECEASED`, `RETIRED`, `EXPIRED`, `RESOLVED`, `UNKNOWN`
`ihi_record_status`	string	`VERIFIED`, `UNVERIFIED`, `PROVISIONAL`, `UNKNOWN`
`has_ihi`	boolean	`already_exists` only: the stored record holds an IHI
`parchment_patient_id`	string	`already_exists` only
`search_paths`	array	`insufficient_data` only: fields that would unlock each path

Status Codes

Code	Meaning
200	Precheck completed — read `data.outcome`
401	Authentication failed
409	Multiple patients share this `partner_patient_id`
422	Validation failed — see `error.validation`
500	Unexpected server error

Notes

Requires the create:patient scope.
The IHI number is never returned. Create the patient to have Parchment store it.
Medicare without medicare_irn as the only identifier reports insufficient_data.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-organization-secret

string

required

Organization secret for authentication - provided by Parchment

Path Parameters

organization_id

string<uuid>

required

Organization ID

user_id

string<uuid>

required

User ID

Body

application/json

Same body as Create Patient. Supply every identifier you hold.

Patient information to be created

given_name

string

required

Patient's given name

family_name

string

required

Patient's family name

date_of_birth

string<date>

required

Patient's date of birth in YYYY-MM-DD format

sex

enum<string>

required

Patient's sex

Available options:

M,

F,

N,

I

partner_patient_id

string

required

Partner's unique identifier for the patient

partner_id

string

required

Your Parchment-assigned partner identifier (lowercase slug, e.g. 'tacklit'). Parchment registers this value during partner onboarding — requests with an unregistered value are rejected with a 422 validation error. Contact Parchment before go-live to have your identifier registered.

Example:

"demo"

dva_file_number

string

DVA file number

ihi_number

string

16-digit Individual Healthcare Identifier (IHI). If omitted, Parchment will attempt to fetch it from the HI Service.

medicare_card_number

string

Medicare card number

medicare_irn

string

Medicare IRN

string<email>

Patient's email address (optional)

phone

string

Patient's Australian mobile number (optional). Must be a valid Australian mobile (04xxxxxxxx or 05xxxxxxxx), digits only. International format with +61 or 61 prefix is also accepted. Landlines are rejected. A mobile number can be used for IHI lookup against the Healthcare Identifiers Service.

australian_street_address

object

Show child attributes

australian_address

object

Alias of australian_street_address. Send one, not both.

Show child attributes

medicare_valid_to

string<date>

Medicare card expiry date

concession_pension_number

string

Concession or pension number

entitlement_number

string

Entitlement number

dva_card_color

enum<string>

DVA card color

Available options:

gold,

white,

orange

racf_id

string

RACF identifier

ctg_eligible

boolean

Closing the Gap eligibility

indigenous_type

enum<string>

Patient's indigenous status

Available options:

aboriginal,

torres_strait_islander,

both,

neither,

not_stated

Response

Precheck completed - read data.outcome for the result

success

boolean

required

Always true for a completed precheck

Example:

true

statusCode

integer

required

HTTP status code

Example:

200

message

string

required

Human-readable summary naming the matched identifier. Informational only.

Example:

"IHI found using mobile number (no record found using Medicare number)"

code

enum<string>

required

Always SUCCESS. Branch on data.outcome instead.

Available options:

SUCCESS

Example:

"SUCCESS"

data

object

required

Codified IHI precheck result. The IHI number itself is never returned.

Show child attributes

timestamp

string<date-time>

required

ISO 8601 timestamp of the response

Example:

"2024-01-15T10:30:00.000Z"

requestId

string

required

Unique identifier for request tracing

Example:

"req_1705312200000_abc123"

IHI Precheck

curl --request POST \
  --url https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/ihi-precheck \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-organization-secret: <x-organization-secret>' \
  --data '
{
  "partner_patient_id": "PMS-000123",
  "partner_id": "demo",
  "given_name": "Denice",
  "family_name": "SHEA",
  "date_of_birth": "1992-12-16",
  "sex": "F",
  "medicare_card_number": "6951907501",
  "medicare_irn": "1",
  "phone": "0417903853",
  "email": "919@Ausnet.com.au",
  "australian_street_address": {
    "street_number": "163",
    "street_name": "Law Rd",
    "suburb": "Jitarning",
    "state": "WA",
    "postcode": "6365"
  }
}
'

import requests

url = "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/ihi-precheck"

payload = {
    "partner_patient_id": "PMS-000123",
    "partner_id": "demo",
    "given_name": "Denice",
    "family_name": "SHEA",
    "date_of_birth": "1992-12-16",
    "sex": "F",
    "medicare_card_number": "6951907501",
    "medicare_irn": "1",
    "phone": "0417903853",
    "email": "919@Ausnet.com.au",
    "australian_street_address": {
        "street_number": "163",
        "street_name": "Law Rd",
        "suburb": "Jitarning",
        "state": "WA",
        "postcode": "6365"
    }
}
headers = {
    "x-organization-secret": "<x-organization-secret>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-organization-secret': '<x-organization-secret>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    partner_patient_id: 'PMS-000123',
    partner_id: 'demo',
    given_name: 'Denice',
    family_name: 'SHEA',
    date_of_birth: '1992-12-16',
    sex: 'F',
    medicare_card_number: '6951907501',
    medicare_irn: '1',
    phone: '0417903853',
    email: '919@Ausnet.com.au',
    australian_street_address: {
      street_number: '163',
      street_name: 'Law Rd',
      suburb: 'Jitarning',
      state: 'WA',
      postcode: '6365'
    }
  })
};

fetch('https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/ihi-precheck', 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.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/ihi-precheck",
  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([
    'partner_patient_id' => 'PMS-000123',
    'partner_id' => 'demo',
    'given_name' => 'Denice',
    'family_name' => 'SHEA',
    'date_of_birth' => '1992-12-16',
    'sex' => 'F',
    'medicare_card_number' => '6951907501',
    'medicare_irn' => '1',
    'phone' => '0417903853',
    'email' => '919@Ausnet.com.au',
    'australian_street_address' => [
        'street_number' => '163',
        'street_name' => 'Law Rd',
        'suburb' => 'Jitarning',
        'state' => 'WA',
        'postcode' => '6365'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-organization-secret: <x-organization-secret>"
  ],
]);

$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.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/ihi-precheck"

	payload := strings.NewReader("{\n  \"partner_patient_id\": \"PMS-000123\",\n  \"partner_id\": \"demo\",\n  \"given_name\": \"Denice\",\n  \"family_name\": \"SHEA\",\n  \"date_of_birth\": \"1992-12-16\",\n  \"sex\": \"F\",\n  \"medicare_card_number\": \"6951907501\",\n  \"medicare_irn\": \"1\",\n  \"phone\": \"0417903853\",\n  \"email\": \"919@Ausnet.com.au\",\n  \"australian_street_address\": {\n    \"street_number\": \"163\",\n    \"street_name\": \"Law Rd\",\n    \"suburb\": \"Jitarning\",\n    \"state\": \"WA\",\n    \"postcode\": \"6365\"\n  }\n}")

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

	req.Header.Add("x-organization-secret", "<x-organization-secret>")
	req.Header.Add("Authorization", "Bearer <token>")
	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.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/ihi-precheck")
  .header("x-organization-secret", "<x-organization-secret>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"partner_patient_id\": \"PMS-000123\",\n  \"partner_id\": \"demo\",\n  \"given_name\": \"Denice\",\n  \"family_name\": \"SHEA\",\n  \"date_of_birth\": \"1992-12-16\",\n  \"sex\": \"F\",\n  \"medicare_card_number\": \"6951907501\",\n  \"medicare_irn\": \"1\",\n  \"phone\": \"0417903853\",\n  \"email\": \"919@Ausnet.com.au\",\n  \"australian_street_address\": {\n    \"street_number\": \"163\",\n    \"street_name\": \"Law Rd\",\n    \"suburb\": \"Jitarning\",\n    \"state\": \"WA\",\n    \"postcode\": \"6365\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/ihi-precheck")

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

request = Net::HTTP::Post.new(url)
request["x-organization-secret"] = '<x-organization-secret>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"partner_patient_id\": \"PMS-000123\",\n  \"partner_id\": \"demo\",\n  \"given_name\": \"Denice\",\n  \"family_name\": \"SHEA\",\n  \"date_of_birth\": \"1992-12-16\",\n  \"sex\": \"F\",\n  \"medicare_card_number\": \"6951907501\",\n  \"medicare_irn\": \"1\",\n  \"phone\": \"0417903853\",\n  \"email\": \"919@Ausnet.com.au\",\n  \"australian_street_address\": {\n    \"street_number\": \"163\",\n    \"street_name\": \"Law Rd\",\n    \"suburb\": \"Jitarning\",\n    \"state\": \"WA\",\n    \"postcode\": \"6365\"\n  }\n}"

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

{
  "success": true,
  "statusCode": 200,
  "message": "IHI found using Medicare number",
  "code": "SUCCESS",
  "data": {
    "outcome": "ihi_found",
    "create_would_succeed": true,
    "ihi_check_passed": true,
    "searched_path": "medicare",
    "ihi_status": "ACTIVE",
    "ihi_record_status": "VERIFIED"
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123"
}

API Documentation

Authentication

Authentication Endpoints

Patient Management Endpoints

User Management Endpoints

Custom Drug Endpoints

Overview

Outcomes

Search Paths

Request Example

Response Examples

IHI Found (200)

IHI Found After Fallback (200)

No Match (200)

Insufficient Data (200)

Patient Already Exists (200)

Validation Error (422)

Response Fields

Status Codes

Notes

Authorizations

Headers

Path Parameters

Body

Response

​Overview

​Outcomes

​Search Paths

​Request Example

​Response Examples

​IHI Found (200)

​IHI Found After Fallback (200)

​No Match (200)

​Insufficient Data (200)

​Patient Already Exists (200)

​Validation Error (422)

​Response Fields

​Status Codes

​Notes

Authorizations

Headers

Path Parameters

Body

Response

Overview

Outcomes

Search Paths

Request Example

Response Examples

IHI Found (200)

IHI Found After Fallback (200)

No Match (200)

Insufficient Data (200)

Patient Already Exists (200)

Validation Error (422)

Response Fields

Status Codes

Notes