search

NCIOCPL / clinical-trials-listing-api

API for Clinical Trial (Dynamic) Listing Pages
2 stars 2 forks source link

Enabler: Implement the models #14

Closed blairlearn closed 3 years ago

blairlearn commented 3 years ago

This is going to be needed for pretty much all the controller stuff....

models

OverrideResults

Contains the return data for retrieving a collection of OverrideRecord objects.

Field JSON name Description
Results results An array of zero or more OverrideRecord objects.
Meta meta Contains metadata about the collection.

EvsResults

Contains the return data for retrieving a collection of EvsRecord objects.

Field JSON name Description
Results results An array of zero or more EvsRecord objects.
Meta meta Contains metadata about the collection.

ResultsMetaData

The metadata portion of an OverrideResults or EvsResults

Field JSON name Description
TotalResults total-results The total number of records available matching the retrieval operation.
From from Zero-based offset into the total collection of matching records for the parent object's Results collection.

EvsRecord

Contains the metadata from EVS describing a disease or intervention.

All fields are inherited from ListingInfo

Sample JSON document [EvsRecord.json]

OverrideRecord

Contains the Overridden form of an EvsRecord.

Field JSON name Description
UniqueId unique_id A unique identifier for the OverrideRecord object.

Inherits all fields from ListingInfo.

Sample JSON document [OverrideRecord.json]

ListingInfo

Abstract base class common to EvsRecord and OverrideRecord.

Field JSON name Description
ConceptId concept_id An array of one or more concept IDs which mapping to this disease or intervention.
Name name Data structure containing the name of the disease or intervention.
PrettyUrlName pretty_url_name Contains the document's browser-friendly path segment. NULL if none exists.

NameInfo

Child class of ListingInfo containing the labels and overrides for the listing item.

Field JSON name Description
Label label The name for the term.
Normalized normalized The label, converted by the loader to a normalized form.

When displaying the term:

LabelInformation

Specifies a text string to replace with a different text string.

Sample JSON document

Field JSON name Description
PrettyUrlName pretty_url_name Url-friendly version of the text which will be replaced.
IdString id_string The "identifier" version of the text to be replaced.
Label label The replacement text.

ESTIMATE TBD

Resources:

Prerequisites

Sub-Tasks

Notes