Layer 1
GenXys Lab Order Specification v1.13

Example Payload

                    
                                {
                                    "orders": [
                                        {
                                            "resourceType": "patient",
                                            "orderedBy": "Doc McDoctor, MD",
                                            "orderedByProviderId": "XYZ-123",
                                            "orderedByInstitution": {
                                                "name": "McDocs Health",
                                                "address": {
                                                    "addressLine1": "123 Main Street",
                                                    "addressLine2": "",
                                                    "city": "Springfield",
                                                    "region": "IL",
                                                    "postalCode": "62704",
                                                    "country": "USA"
                                               },
                                            },
                                            "clinicIdentifier": "HCP_CLINIC_IDENTIFIER",
                                            "clinicType": "HCP_CLINIC_IDENTIFIER-TYPE",
                                            "clinicInstance": "HCP_CLINIC_INSTANCE",
                                            "barcode": "LAB_IDENTIFIER",
                                            "panel": "PANEL_IDENTIFIER",
                                            "tag": "TAG_IDENTIFIER",
                                            "payload": {
                                                "identifier": "DEF-456",
                                                "identifiers": [
                                                    {
                                                        "identifierType": "MR",
                                                        "identifierValue": "111-222-333-444"
                                                    },
                                                    {
                                                        "identifierType": "DL",
                                                        "identifierValue": "999-999-999"
                                                    }
                                                ],
                                                "firstName": "Test2",
                                                "lastName": "Genxys",
                                                "demographics": {
                                                    "dob": "1970-01-07",
                                                    "sexAtBirth": "F",
                                                    "email": "tgen@genxys.com",
                                                    "address": {
                                                        "addressLine1": "123 Sesame Street",
                                                        "addressLine2": "",
                                                        "city": "Anytown",
                                                        "region": "CA",
                                                        "postalCode": "90210",
                                                        "country": "US"
                                                    },
                                                    "ethnicity": {
                                                        "name": "African/African American",
                                                        "coding": {
                                                            "system": "gnomAD",
                                                            "code": "AFR"
                                                        }
                                                    }
                                                },
                                                "notes": "",
                                                "medicalSummary": {
                                                    "currentMedications": [
                                                        {
                                                            "name": "ACH-ATORVASTATIN 40 MG TABLET",
                                                            "dosage": "1 Tablet, QD",
                                                            "coding": {
                                                                "system": "DIN",
                                                                "code": "2457776"
                                                            },
                                                            "indication": {
                                                                "name": "Attention Deficit Hyperactivity Disorder",
                                                                "coding": {
                                                                    "system": "ICD9",
                                                                    "code": "314.01"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            "name": "ACT CLOPIDOGREL 75 MG TABLET",
                                                            "dosage": "1 puff, Q12H",
                                                            "coding": {
                                                                "system": "DIN",
                                                                "code": "2303027"
                                                            },
                                                            "indication": {
                                                                "name": "Diabetes Mellitus Type 2",
                                                                "coding": {
                                                                    "system": "ICD9",
                                                                    "code": "250.00"
                                                                }
                                                            }
                                                        }
                                                    ],
                                                    "consideredMedications": [
                                                        {
                                                            "name": "Acetaminophen 500 MG Oral Tablet",
                                                            "dosage": "1 Tablet, PRN",
                                                            "coding": {
                                                                "system": "RxCUI",
                                                                "code": "209459"
                                                            },
                                                            "indication": {
                                                                "name": "Chronic Pain - Low Back Pain",
                                                                "coding": {
                                                                    "system": "ICD9",
                                                                    "code": "724.2"
                                                                }
                                                            }
                                                        }
                                                    ]
                                                },
                                                "specimen": {
                                                    "sampleId": "",
                                                    "type": "",
                                                    "date": "2022-04-14",
                                                    "received": "2022-04-28",
                                                    "quality": "Extracted 3x"
                                                }
                                            }
                                        },
                                        {
                                            "resourceType": "patient",
                                            "orderedBy": "Doc McDoctor, MD",
                                            "orderedByProviderId": "XYZ-123",
                                            "orderedByInstitution": {
                                                "name": "McDocs Health",
                                                "address": {
                                                    "addressLine1": "123 Main Street",
                                                    "addressLine2": "",
                                                    "city": "Springfield",
                                                    "region": "IL",
                                                    "postalCode": "62704",
                                                    "country": "USA"
                                               },
                                            },
                                            "clinicIdentifier": "HCP_CLINIC_IDENTIFIER",
                                            "clinicType": "HCP_CLINIC_IDENTIFIER-TYPE",
                                            "clinicInstance": "HCP_CLINIC_INSTANCE",
                                            "barcode": "LAB_IDENTIFIER",
                                            "payload": {
                                                "identifier": "ABC-123",
                                                "identifiers": [
                                                    {
                                                        "identifierType": "MR",
                                                        "identifierValue": "123-456-789"
                                                    }
                                                ],
                                                "firstName": "Test",
                                                "lastName": "Genxys",
                                                "demographics": {
                                                    "dob": "1965-01-07",
                                                    "sexAtBirth": "M",
                                                    "email": "tgen@genxys.com",
                                                    "address": {
                                                        "addressLine1": "123 High Street",
                                                        "addressLine2": "",
                                                        "city": "Anytown",
                                                        "region": "BC",
                                                        "postalCode": "V1K 1K1",
                                                        "country": "CAN"
                                                    }
                                                },
                                                "notes": "",
                                                "medicalSummary": {
                                                    "currentMedications": [
                                                        {
                                                            "name": "ACH-ATORVASTATIN 40 MG TABLET",
                                                            "dosage": "1 Tablet, QD",
                                                            "coding": {
                                                                "system": "DIN",
                                                                "code": "2457776"
                                                            },
                                                            "indication": {
                                                                "name": "Attention Deficit Hyperactivity Disorder",
                                                                "coding": {
                                                                    "system": "ICD9",
                                                                    "code": "314.01"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            "name": "ACT CLOPIDOGREL 75 MG TABLET",
                                                            "dosage": "1 puff, Q12H",
                                                            "coding": {
                                                                "system": "DIN",
                                                                "code": "2303027"
                                                            },
                                                            "indication": {
                                                                "name": "Diabetes Mellitus Type 2",
                                                                "coding": {
                                                                    "system": "ICD9",
                                                                    "code": "250.00"
                                                                }
                                                            }
                                                        }
                                                    ]
                                                },
                                                "specimen": {
                                                    "sampleId": "",
                                                    "type": "",
                                                    "date": "2022-04-14",
                                                    "received": "2022-04-28"
                                                }
                                            }
                                        }
                                    ],
                                    "instrumentFiles": {
                                        "CNV": "QW5hbHlzaXMgU29mdHdhcmU6IENvcHlDYWxsZXIgdjIuMQoKCkZpbGU...",
                                        "OA": "QW5hbHlzaXMgU29mdHdhcmU6IENvcHlDYWxsZXIgdjIuMQoKCkZpbGU...",
                                        "AUX": "QW5hbHlzaXMgU29mdHdhcmU6IENvcHlDYWxsZXIgdjIuMQoKCkZpbGU...",
                                        "SNP": "QW5hbHlzaXMgU29mdHdhcmU6IENvcHlDYWxsZXIgdjIuMQoKCkZpbGU...",
                                        "STR": "QW5hbHlzaXMgU29mdHdhcmU6IENvcHlDYWxsZXIgdjIuMQoKCkZpbGU...",
                                        "VCF": "QW5hbHlzaXMgU29mdHdhcmU6IENvcHlDYWxsZXIgdjIuMQoKCkZpbGU...",
                                        "ULR": "[{...},{...}]",
                                    }
                                }
                    
                

Definitions

Orders
resourceType
Required string
"patient" "hcp"

hcp - not supported in v1

orderedBy
Required
string

The health care provider who has ordered the test

orderedByProviderId
string

The health care provider identifier

orderedByInstitution
object

Ordering Institution

orderedByInstitution / name
string

Name of the ordering institution

orderedByInstitution / address
object

Address of the ordering institution

orderedByInstitution / address / addressLine1
string

Ordering institution street address

orderedByInstitution / address / addressLine2
string

Ordering institution street address continued

orderedByInstitution / address / city
string

Ordering institution city

orderedByInstitution / address / region
string

Ordering institution region

orderedByInstitution / address / postalCode
string

Ordering institution postal/zip code

orderedByInstitution / address / country
string

Ordering institution country

clinicIdentifier
Required
string

GenXys clinic identifier is a required field that can be set to the lab's clinic identifier or the associated HCP's clinic identifier

clinicType
string

GenXys clinic type is an optional value for a HCP the report should be associated with

clinicInstance
string

GenXys clinic instance is an optional value for a HCP the report should be associated with

barcode
Required
string

Barcode is the internal lab identifier for associating a patient order with corresponding results. If no barcode is specified, the patient identifer will be used for this field.

panel
string

Panel identifier (optional) for multi-panel solutions. Will override default report templates if specified and matches a template of the same name.

tag
string

Tag identifier (optional) for custom templates. Will override default report template if specified and matches a template of the same name.

payload
object

Patient payload

payload / identifier
string

Identifer is the patient identifier associated with a patient case in the GenXys Portal. It allows results to be pushed to an existing patient case in the GenXys Portal.

payload / identifiers
array

Identifers are the patient identifiers associated with a patient case in the GenXys Portal. It allows results to be pushed to an existing patient case in the GenXys Portal.

payload / identifiers / identifierType
string

Identifier Type

"DL" "MR" "NH" "PHN" "PRN" "SB"

DL Drivers License

MR Medical Record Number

NH National Health Service

PHN Patient Health Number

PRN Provider Number

SB Social Beneficiary

payload / identifiers / identifierValue
string

Identifier Value

Value associated with identifier type.

Maximum length is 50 characters.

payload / firstName
Required
string

First Name

payload / lastName
Required
string

Last Name

payload / demographics

Patient demographics

object
payload / demographics / dob
Required
string
"YYYY-MM-DD"

Date of Birth

payload / demographics / sexAtBirth
Required
string
"M" "F" "U"

Sex at Birth

payload / demographics / email
string

patient email address

payload / demographics / address
object

Patient address

payload / demographics / address / addressLine1
string

patient street address

payload / demographics / address / addressLine2
string

patient street address continued

payload / demographics / address / city
string

City

payload / demographics / address / region
string

Region

"Postal Abbreviations (CA,AR,AK etc)"
payload / demographics / address / postalCode
string

Postal Code

payload / demographics / address / country
string

Country

"Abbreviations US/CAN"
payload / demographics / ethnicity
object

Ethnicity

payload / demographics / ethnicity / name
string

Ethnicity label for a given ancestry classification (e.g., 'East Asian', 'Sub-Saharan African')

payload / demographics / ethnicity / coding
object

Ethnicity encoding

payload / demographics / ethnicity / coding / system
string

The classification system or ontology used to define the ancestry groups

payload / demographics / ethnicity / coding / code
string

Code assigned to the ancestry group within the specified classification system

payload / specimen
object

Sample specimen

payload / specimen / sampleId
Required
string

The identifier associated with the sample specimen

payload / specimen / type
Required
string

The type of specimen (i.e. swab, blood etc)

payload / specimen / date
Required
string

The specimen collection date

payload / specimen / received
string

The date the specimen was received from the patient

payload / specimen / quality
string

Specimen quality is an optional value detailing the quality of the sample

payload / notes
string

Patient Notes

payload / medicalSummary
object

Patient Medical Summary

payload / medicalSummary / currentMedications
array

Patient Current Medications

payload / medicalSummary / currentMedications / name
string

Drug Name (Brand/Generic)

payload / medicalSummary / currentMedications / dosage
string
"[DOSE] [FORM], [FREQUENCY] i.e. 2 Tablet, QD"

Form:

application application

bottle bottle

capsule capsule

dose dose

drop drop

g g

mg mg

package package

puff puff

spray spray

tablet tablet

unit unit

vial vial



Frequency:

1xMonth Once a month

1xWeek Once a week

1xYear Once a year

21/28D 21 out of 28 days

2xWeek 2 times a week

3xWeek 3 times a week

4xWeek 4 times a week

5xWeek 5 times a week

6xWeek 6 times a week

BID Two times daily

MWF Mon, Wed, Fri

ONCE One time only

PRN As needed

Q12H Every 12 hours

Q1-2H Every 1 to 2 hours

Q12W Every 12 weeks

Q2D Every other day

Q2H Every 2 hours

Q2W Every 2 weeks

Q4-6H Every 4 to 6 hours

Q4H Every 4 hours

Q4W Every 4 weeks

Q6-8H Every 6 to 8 hours

Q6H Every 6 hours

Q6W Every 6 weeks

Q8H Every 8 hours

Q8W Every 8 weeks

QAM Every morning

QD Once daily

QHS Every day at bedtime

QID Four times daily

QNOON Every day at noon

QPM Every evening

TID Three times daily

TTSS Tues, Thur, Sat, Sun

Dosage

payload / medicalSummary / currentMedications / coding
object

Medication encoding

payload / medicalSummary / currentMedications / coding / system
"RXCUI" "NDC" "DIN"
string

Drug Identifier System

payload / medicalSummary / currentMedications / coding / code
string

Drug Identifier

payload / medicalSummary / currentMedications / indication
object

Medication condition

payload / medicalSummary / currentMedications / indication / name
string

Condition name

payload / medicalSummary / currentMedications / indication / coding
object

Condition encoding

payload / medicalSummary / currentMedications / indication / coding / system
"SNOMED" "ICD9" "ICD10" "ICD11"
string

Condition Identifier System

payload / medicalSummary / currentMedications / indication / coding / code
string

Condition Identifier

payload / medicalSummary / consideredMedications
array

Medications under review or contemplated but are not part of the active prescription list.

Follow medication specificaiton as described under currentMedications

Instrument Files
CNV
base64

CNV data file, should accompany an OA and optional HLA file.

HLA
base64

HLA data file, should accompany a CNV and OA file.

OA
base64

OA data file, should accompany a CSV and optional HLA file.

SNP
base64

SNP data file, should accompany a STR file.

STR
base64

STR data file, should accompany a SNP file.

AUX
base64

AUX data file.

ULR
object

ULR data file.

VCF
base64

Variant Call Format (VCF) data file.