Create a new Revealia sample in sandbox

Authorization

ght-api-key<token>

In: header

Request Body

application/jsonRequired

firstNameRequiredstring

Patient first name

middleNamestring

Patient middle name

lastNameRequiredstring

Patient last name

dobRequiredstring

Date of birth in YYYY-MM-DD format

genderRequiredstring

Patient gender

Value in: "MALE" | "FEMALE"

racestring

Patient race

Default: "Undisclosed"Value in:

"Caucasian" | "Black or African American" | "Asian" | "Native Hawaiian or other Pacific Islander" | "American Indian or Alaska Native" | "Two or More" | "Other" | "Undisclosed"

ethnicitystring

Patient ethnicity

addressStreet1Requiredstring

Patient street address line 1

addressStreet2string

Patient street address line 2

addressCityRequiredstring

Patient city

addressStateRequiredstring

Patient state/region

Value in:

"Alabama" | "Alaska" | "Arizona" | "Arkansas" | "California" | "Colorado" | "Connecticut" | "Delaware" | "District of Columbia" | "Florida" | "Georgia" | "Hawaii" | "Idaho" | "Illinois" | "Indiana" | "Iowa" | "Kansas" | "Kentucky" | "Louisiana" | "Maine" | "Maryland" | "Massachusetts" | "Michigan" | "Minnesota" | "Mississippi" | "Missouri" | "Montana" | "Nebraska" | "Nevada" | "New Hampshire" | "New Jersey" | "New Mexico" | "New York" | "North Carolina" | "North Dakota" | "Ohio" | "Oklahoma" | "Oregon" | "Pennsylvania" | "Rhode Island" | "South Carolina" | "South Dakota" | "Tennessee" | "Texas" | "Utah" | "Vermont" | "Virginia" | "Washington" | "West Virginia" | "Wisconsin" | "Wyoming" | "AK" | "AL" | "AR" | "AZ" | "CA" | "CO" | "CT" | "DC" | "DE" | "FL" | "GA" | "HI" | "IA" | "ID" | "IL" | "IN" | "KS" | "KY" | "LA" | "MA" | "MD" | "ME" | "MI" | "MN" | "MO" | "MS" | "MT" | "NC" | "ND" | "NE" | "NH" | "NJ" | "NM" | "NV" | "NY" | "OH" | "OK" | "OR" | "PA" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VA" | "VT" | "WA" | "WI" | "WV" | "WY"

addressPostalCodeRequiredstring

Patient postal code

addressCountryRequiredstring

Patient country

Default: "United States"

phone1Requiredstring

Patient phone number

patientEmailRequiredstring

Patient email address

testSelectionRequiredstring

Test selection

Value in: "Revealia Test"

orderingProviderNameRequiredstring

Ordering provider name

orderingProviderNpiRequiredstring

Ordering provider national provider identifier

orderingProviderPracticeNameRequiredstring

Ordering provider practice name

orderingProviderAddressRequiredstring

Ordering provider address (formerly PCP address)

orderingProviderCityRequiredstring

Ordering provider city

orderingProviderStateRequiredstring

Ordering provider state

Value in:

"AK" | "AL" | "AR" | "AZ" | "CA" | "CO" | "CT" | "DC" | "DE" | "FL" | "GA" | "HI" | "IA" | "ID" | "IL" | "IN" | "KS" | "KY" | "LA" | "MA" | "MD" | "ME" | "MI" | "MN" | "MO" | "MS" | "MT" | "NC" | "ND" | "NE" | "NH" | "NJ" | "NM" | "NV" | "NY" | "OH" | "OK" | "OR" | "PA" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VA" | "VT" | "WA" | "WI" | "WV" | "WY"

orderingProviderZipRequiredstring

Ordering provider zip code (formerly PCP zip)

orderingProviderPhoneRequiredstring

Ordering provider phone number (formerly PCP phone)

orderingProviderFaxstring

Ordering provider fax number (formerly PCP fax) - Optional

replacementForstring

ID that this sample is replacing

curl -X POST "https://example.com/sandbox/lsm/revealia/create-sample" \
  -H "ght-api-key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "John",
    "middleName": "Andrew",
    "lastName": "Doe",
    "dob": "1980-01-15",
    "gender": "MALE",
    "race": "Caucasian",
    "ethnicity": "Non Hispanic",
    "addressStreet1": "123 Main St",
    "addressStreet2": "Apt 4B",
    "addressCity": "San Francisco",
    "addressState": "CA",
    "addressPostalCode": "94107",
    "addressCountry": "United States",
    "phone1": "555-123-4567",
    "patientEmail": "patient@example.com",
    "testSelection": "Revealia Test",
    "orderingProviderName": "Dr. Jane Smith",
    "orderingProviderNpi": "1234567890",
    "orderingProviderPracticeName": "Anytown Medical Group",
    "orderingProviderAddress": "456 Medical Parkway",
    "orderingProviderCity": "Anytown",
    "orderingProviderState": "CA",
    "orderingProviderZip": "12345",
    "orderingProviderPhone": "555-987-6543",
    "orderingProviderFax": "555-678-9012",
    "replacementFor": "CGX001"
  }'

Revealia sample created successfully in sandbox

{
  "success": true,
  "message": "Revealia sample created successfully",
  "recordId": "123456",
  "revealiaId": "REV001",
  "replacementFor": "REV000"
}

Create a new Revealia sample in sandbox

Authorization

Request Body

Response

TypeScript