Jump to

• Request
• Response

[Deprecated]: v1.0

post

/ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{labId}/labnormals/bulkLookUp

Retrieves all lab normals for the given list of lab criteria.

Request

Path Parameters

• labId(required): string
  The lab ID for which to create lab normals.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : LabNormalLookUpRequest v1.0

Type: object

Title: LabNormalLookUpRequest v1.0

Payload that carries lab normal lookup criteria.

Show Source

• lookUpCriteria: array Lookup Criteria
  Title: Lookup Criteria

  List of criteria used to look up lab normals.

{
    "title":"LabNormalLookUpRequest v1.0",
    "type":"object",
    "properties":{
        "lookUpCriteria":{
            "title":"Lookup Criteria",
            "type":"array",
            "description":"List of criteria used to look up lab normals.",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/LabNormalLookUpCriteriaV1"
            }
        }
    },
    "description":"Payload that carries lab normal lookup criteria."
}

Nested Schema : Lookup Criteria

Type: array

Title: Lookup Criteria

List of criteria used to look up lab normals.

Show Source

• Array of: object LabNormalLookUpCriteria v1.0
  Title: LabNormalLookUpCriteria v1.0

  Criteria used to locate lab normals.

{
    "title":"Lookup Criteria",
    "type":"array",
    "description":"List of criteria used to look up lab normals.",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/LabNormalLookUpCriteriaV1"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : LabNormalLookUpCriteria v1.0

Type: object

Title: LabNormalLookUpCriteria v1.0

Criteria used to locate lab normals.

Show Source

• age: string
  Title: Age

  Age used as a lookup criterion.

  Example: 10
• ageUnits: string
  Title: Age Units

  Units for the lookup age.

  Example: years
• collectionDate: string (date)
  Title: Collection Date

  Collection date used as a lookup criterion.

  Example: 2025-01-01
• fasting: string
  Title: Fasting

  Fasting flag used as a lookup criterion.

  Example: Yes
• gender: string
  Title: Gender

  Gender used as a lookup criterion.

  Example: Female
• race: string
  Title: Race

  Race used as a lookup criterion.

  Example: Asian
• testName: string
  Title: Test Name

  Test name used as a lookup criterion.

  Example: HEMOGLOBIN

{
    "title":"LabNormalLookUpCriteria v1.0",
    "type":"object",
    "properties":{
        "testName":{
            "title":"Test Name",
            "type":"string",
            "description":"Test name used as a lookup criterion.",
            "example":"HEMOGLOBIN"
        },
        "gender":{
            "title":"Gender",
            "type":"string",
            "description":"Gender used as a lookup criterion.",
            "example":"Female"
        },
        "race":{
            "title":"Race",
            "type":"string",
            "description":"Race used as a lookup criterion.",
            "example":"Asian"
        },
        "age":{
            "title":"Age",
            "type":"string",
            "description":"Age used as a lookup criterion.",
            "example":"10"
        },
        "ageUnits":{
            "title":"Age Units",
            "type":"string",
            "description":"Units for the lookup age.",
            "example":"years"
        },
        "collectionDate":{
            "title":"Collection Date",
            "type":"string",
            "description":"Collection date used as a lookup criterion.",
            "format":"date",
            "example":"2025-01-01"
        },
        "fasting":{
            "title":"Fasting",
            "type":"string",
            "description":"Fasting flag used as a lookup criterion.",
            "example":"Yes"
        }
    },
    "description":"Criteria used to locate lab normals."
}

Examples

Select an example Request Example

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : LabNormalBulkLookUpResponse v1.0

Type: object

Title: LabNormalBulkLookUpResponse v1.0

Bulk lookup response for lab normals.

Show Source

• labNormals: array Lab Normals
  Title: Lab Normals

  Lookup responses returned by the bulk lookup.

{
    "title":"LabNormalBulkLookUpResponse v1.0",
    "type":"object",
    "properties":{
        "labNormals":{
            "title":"Lab Normals",
            "type":"array",
            "description":"Lookup responses returned by the bulk lookup.",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/LookUpResponseV1"
            }
        }
    },
    "description":"Bulk lookup response for lab normals."
}

Nested Schema : Lab Normals

Type: array

Title: Lab Normals

Lookup responses returned by the bulk lookup.

Show Source

• Array of: object LookUpResponse v1.0
  Title: LookUpResponse v1.0

  One lab normal lookup result.

{
    "title":"Lab Normals",
    "type":"array",
    "description":"Lookup responses returned by the bulk lookup.",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/LookUpResponseV1"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : LookUpResponse v1.0

Type: object

Title: LookUpResponse v1.0

One lab normal lookup result.

Show Source

• age: string
  Title: Age

  Age associated with the lookup result.

  Example: 10
• ageUnits: string
  Title: Age Units

  Age units associated with the lookup result.

  Example: years
• collectionDate: string (date)
  Title: Collection Date

  Collection date associated with the lookup result.

  Example: 2025-01-01
• fasting: string
  Title: Fasting

  Fasting info returned by the lookup.

  Example: Yes
• gender: string
  Title: Gender

  Gender associated with the lookup result.

  Example: Female
• labNormalsData: array Lab Normals
  Title: Lab Normals

  List of lab normals matching the lookup result.
• race: string
  Title: Race

  Race associated with the lookup result.

  Example: Asian
• testName: string
  Title: Test Name

  Test name returned by the lookup.

  Example: HEMOGLOBIN

{
    "title":"LookUpResponse v1.0",
    "type":"object",
    "properties":{
        "testName":{
            "title":"Test Name",
            "type":"string",
            "description":"Test name returned by the lookup.",
            "example":"HEMOGLOBIN"
        },
        "gender":{
            "title":"Gender",
            "type":"string",
            "description":"Gender associated with the lookup result.",
            "example":"Female"
        },
        "race":{
            "title":"Race",
            "type":"string",
            "description":"Race associated with the lookup result.",
            "example":"Asian"
        },
        "age":{
            "title":"Age",
            "type":"string",
            "description":"Age associated with the lookup result.",
            "example":"10"
        },
        "ageUnits":{
            "title":"Age Units",
            "type":"string",
            "description":"Age units associated with the lookup result.",
            "example":"years"
        },
        "collectionDate":{
            "title":"Collection Date",
            "type":"string",
            "description":"Collection date associated with the lookup result.",
            "format":"date",
            "example":"2025-01-01"
        },
        "fasting":{
            "title":"Fasting",
            "type":"string",
            "description":"Fasting info returned by the lookup.",
            "example":"Yes"
        },
        "labNormalsData":{
            "title":"Lab Normals",
            "type":"array",
            "description":"List of lab normals matching the lookup result.",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/LabNormalTO"
            }
        }
    },
    "description":"One lab normal lookup result."
}

Nested Schema : Lab Normals

Type: array

Title: Lab Normals

List of lab normals matching the lookup result.

Show Source

• Array of: object LabNormalTO v1.0
  Title: LabNormalTO v1.0

  Schema describing a lab normal entry.

{
    "title":"Lab Normals",
    "type":"array",
    "description":"List of lab normals matching the lookup result.",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/LabNormalTO"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : LabNormalTO v1.0

Type: object

Title: LabNormalTO v1.0

Schema describing a lab normal entry.

Show Source

• ageFrom(required): integer (int32)
  Title: Age From

  Lower bound for the age range.

  Example: 5
• ageFromUnits(required): string
  Title: Age From Units

  Units used for the lower age bound.

  Example: years
• ageTo(required): integer (int32)
  Title: Age To

  Upper bound for the age range.

  Example: 15
• ageToUnits(required): string
  Title: Age To Units

  Units used for the upper age bound.

  Example: years
• effectiveDate(required): string (date)
  Title: Effective Date

  Date when the lab normal becomes effective.

  Example: 2025-01-01
• fasting: string
  Title: Fasting

  Allowed Values: [ "Yes", "No" ]

  Fasting flag for the lab normal.

  Example: Yes
• gender: string
  Title: Gender

  Gender applicable to the lab normal.

  Example: Female
• highRange: string
  Title: High Range

  Upper limit for the lab normal range.

  Example: 100
• labNormalId: string (uuid)
• labUnit: string
  Title: Lab Unit

  Measurement unit for the lab test.

  Example: mg/dL
• lowRange: string
  Title: Low Range

  Lower limit for the lab normal range.

  Example: 10
• race: string
  Title: Race

  Race targeted by the lab normal.

  Example: Asian
• sequence(required): integer (int32)
  Title: Sequence

  Minimum Value: 1

  Ordering number for the lab normal.

  Example: 5
• standardResult: string
  Title: Standard Result

  Standard result value for the lab normal.

  Example: 100
• test(required): string
  Title: Test

  Name of the lab test.

  Example: HEMOGLOBIN

{
    "title":"LabNormalTO v1.0",
    "required":[
        "ageFrom",
        "ageFromUnits",
        "ageTo",
        "ageToUnits",
        "effectiveDate",
        "sequence",
        "test"
    ],
    "type":"object",
    "properties":{
        "labNormalId":{
            "type":"string",
            "format":"uuid"
        },
        "sequence":{
            "title":"Sequence",
            "minimum":1,
            "type":"integer",
            "description":"Ordering number for the lab normal.",
            "format":"int32",
            "example":5
        },
        "test":{
            "title":"Test",
            "type":"string",
            "description":"Name of the lab test.",
            "example":"HEMOGLOBIN"
        },
        "labUnit":{
            "title":"Lab Unit",
            "type":"string",
            "description":"Measurement unit for the lab test.",
            "example":"mg/dL"
        },
        "lowRange":{
            "title":"Low Range",
            "type":"string",
            "description":"Lower limit for the lab normal range.",
            "example":"10"
        },
        "highRange":{
            "title":"High Range",
            "type":"string",
            "description":"Upper limit for the lab normal range.",
            "example":"100"
        },
        "standardResult":{
            "title":"Standard Result",
            "type":"string",
            "description":"Standard result value for the lab normal.",
            "example":"100"
        },
        "gender":{
            "title":"Gender",
            "type":"string",
            "description":"Gender applicable to the lab normal.",
            "example":"Female"
        },
        "ageFrom":{
            "title":"Age From",
            "type":"integer",
            "description":"Lower bound for the age range.",
            "format":"int32",
            "example":5
        },
        "ageTo":{
            "title":"Age To",
            "type":"integer",
            "description":"Upper bound for the age range.",
            "format":"int32",
            "example":15
        },
        "ageFromUnits":{
            "title":"Age From Units",
            "type":"string",
            "description":"Units used for the lower age bound.",
            "example":"years"
        },
        "ageToUnits":{
            "title":"Age To Units",
            "type":"string",
            "description":"Units used for the upper age bound.",
            "example":"years"
        },
        "race":{
            "title":"Race",
            "type":"string",
            "description":"Race targeted by the lab normal.",
            "example":"Asian"
        },
        "fasting":{
            "title":"Fasting",
            "type":"string",
            "description":"Fasting flag for the lab normal.",
            "example":"Yes",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "effectiveDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"Date when the lab normal becomes effective.",
            "format":"date",
            "example":"2025-01-01"
        }
    },
    "description":"Schema describing a lab normal entry."
}

Examples

Select an example Success Response

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.

Body ()

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

• errorData: object ErrorResponseData
• result: object result
  The result object for successful requests. Type depends on the API operation.
• status: string
  Status of the response, either 'success' or an error indication.

  Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : details

Type: object

Examples

Select an example Error Response

Back to Top