CreatePatient

This API allows the user to upload patient/subject information prior to a VCF sample being uploaded. If you would like to load the patient data using a JSON file, please use the command line feature available here: https://github.com/geneyx/geneyx.analysis.api/tree/main/scripts.

URL:

https://analysis.geneyx.com/api/Patient

Action:

POST

Payload:

JSON Structure

Requirements:

Category	Parameter	Description	Required
Auth	ApiUserId	The API user Id	Yes
	ApiUserKey	The API user key	Yes
Subject	SerialNumber	The case serial number. In case the SN is not provided it shall be automatically generated by server.	No
	Name	Name of sample.	No
	DateOfBirth	Date of birth (YYYY-MM-DD)	No
	Gender	Gender	No
	Consang	Consanguinuity	No
	PopulationType	PopulationType	No
	PaternalAncestry	PaternalAncestry	No
	MaternalAncestry	MaternalAncestry	No
	PaternalGrandfather	PaternalGrandfather	No
	PaternalGrandmother	PaternalGrandmother	No
	MaternalGrandfather	MaternalGrandfather	No
	MaternalGrandmother	MaternalGrandmother	No
	FamilyHistory	FamilyHistory	No
	UseConsentPersonal	UseConsentPersonal	No
	UseConsentClinical	UseConsentClinical	No
	HasBioSample	HasBioSample	No
	GenerallyHealthy	GenerallyHealthy	No
	ClinicalRecords	Includes “RecordDate”, “Description”, “PhenotypeCodes”	No

Request

"{
    "SerialNumber": "123456789",
    "Name": "Patient-Name",
    "DateOfBirth": "2001-06-25", 
    "Gender": "M",
    "Consang": "NonConsang",
    "PopulationType": "general population",
    "PaternalAncestry": "string",
    "MaternalAncestry": "string",
    "PaternalGrandfather": "string",
    "PaternalGrandmother": "string",
    "MaternalGrandfather": "string",
    "MaternalGrandmother": "string",
    "FamilyHistory": "long long history of nothing",
    "UseConsentPersonal": "true",
    "UseConsentClinical": "false",
    "HasBioSample": "true",
    "GenerallyHealthy": "false",

    "ClinicalRecords": [
      {
        "RecordDate": "2005-06-25",
        "Description": "recorded something",
        "PhenotypeCodes": [
            "HP:0002000"            
        ]
      }
    ]
  }"

Response

{
    "Code": "success",
    "Data": {
        "SerialNumber": "0123456789",
        "Name": "Patient-Name",
        "DateOfBirth": "2001-06-25T00:00:00",
        "Gender": "M",
        "Consang": 2,
        "ConsangName": "NonConsang",
        "PopulationType": "general population",
        "PaternalAncestry": "string",
        "MaternalAncestry": "string",
        "FamilyHistory": "long long history of nothing",
        "YearOfBirth": null,
        "UseConsentPersonal": true,
        "UseConsentClinical": false,
        "HasBioSample": true,
        "GenerallyHealthy": false,
        "PaternalGrandfather": "string",
        "PaternalGrandmother": "string",
        "MaternalGrandfather": "string",
        "MaternalGrandmother": "string",
        "Groups": null,
        "ID": "cae39194-eb91-45b6-a7ff-ac9688a3731d",
        "CreatedByUser": "Eli Sward",
        "CreateDate": "2023-04-14T19:07:39.2267917Z",
        "ModifiedByUser": "Eli Sward",
        "ModifyDate": "2023-04-14T19:07:39.2267917Z"
    },
    "Info": null,
    "MoreInfo": null,
    "NeedEval": false
}