AddClinicalRecord - geneyx/geneyx.analysis.api GitHub Wiki

AddClinicalRecord

This API allows the user to add a clinical record to an existing patient.

URL:

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

Action:

POST

Payload:

JSON Structure

Requirements:

Category Parameter Description Required
Auth ApiUserId The API user Id Yes
ApiUserKey The API user key Yes
Subject SubjectId The Subject ID Yes
RecordDate Date record was recorded in UTC. Yes
Description Clinical description. No
PhenotypeCodes Human Phenotype, or free search terms No

Request

{
  "ApiUserId": "API User ID",
  "ApiUserKey": "API User Key",
  "SubjectId": "0123456789",
  "RecordDate": "2005-06-25",
  "Description": "recorded something new",
  "PhenotypeCodes": [
    "HP:0001903",
    "HP:0000005"            
        ]
}

Response

{
    "Code": "success",
    "Data": {
        "ID": "68ffe0cd-a976-4744-af68-8e7113b8f08d",
        "Description": "recorded something new",
        "PatientId": "cae39194-eb91-45b6-a7ff-ac9688a3731d",
        "RecordDate": "2005-06-25T00:00:00",
        "PhenotypeCodes": [
            {
                "id": "HP:0001903",
                "name": "Anemia"
            },
            {
                "id": "HP:0000005",
                "name": "Mode of inheritance"
            }
        ]
    },
    "Info": null,
    "MoreInfo": null,
    "NeedEval": false
}
⚠️ **GitHub.com Fallback** ⚠️