v2 → v3 Enum Changes
Shared enums keep identical value sets across schema versions. What changes between v2 and v3 is which enums are exposed. Open the Enum Registry and pick a schema to see the exact set.
Removed in v3
- CompanyFilterTypeSelects which kind of company association a filter targets.
- JobRoleV1Coarse job-role classification, serialized as an integer code. Superseded by JobRoleV2.
- JobSubRoleV1Fine-grained job sub-role, serialized as an integer code. Superseded by JobSubRoleV2.
- PersonEnrichmentProblemTypeReason a person enrichment request could not be fulfilled.
- RelationshipTypeDirection of a company relationship search; only used when companyFilter=RELATIONSHIP. Values name what is returned, not the role of the seed company.
Added in v3
- AuthorPositionWhere an HCP appears in a publication's author list.
- CongressSessionTypeThe kind of congress session an HCP presented at, upper-cased from the congress program.
- DeepMatchBatchStatusLifecycle status of a Deep Match batch.
- DeepMatchOutcomeHow a single Deep Match row resolved.
- HcpClaimRoleThe part an HCP played on the medical claims their diagnosis and procedure counts are drawn from. Each role is counted separately and the two are never added together.
- HcpConditionsTreatedSortThe measure an HCP's conditions treated are ordered by, summed over the requested years.
- HcpDiscoverVocabularyA vocabulary the healthcare discover resolve endpoint looks names up in. Each names the request field its IDs go in.
- HcpDrugsPrescribedSortThe measure an HCP's drugs prescribed are ordered by, summed over the requested years. The two are different units and are never added together.
- HealthcareTaxonomyIdThe healthcare category taxonomy to browse.
- KeywordSearchFieldA prose field the v3 keywords filter can search.
- LeaderboardOne of H1's per-indication HCP rankings, upper-cased from its name. Each ranks HCPs in deciles from 1 to 10.
- LicensureTypeHow FDA licensed a biological product, from the Purple Book. Only products licensed under a BLA carry one.
- PatientThresholdHow many distinct patients a claims criterion needs over the trailing twelve months.
- PersonListAddStatusThe outcome of adding one item to a list.
- PersonListMemberSourceHow a person was added to a list.
- PracticeSettingThe kind of organization an HCP currently works at, from their current US work affiliations. An HCP carries every setting that applies, and one whose organization is unresolved carries none.
- PrivateEquityInvestmentTypeHow a private equity firm invested in a company during one holding period.
- PrivateEquityInvestorTypeWhat kind of organization owns a private equity firm.
- PrivateEquityManagerTypeThe kind of investment firm managing a private equity holding.
- RelationshipDirectionThe role the seed companies play in a relationship search; only used when companyFilter=RELATIONSHIP.
- RevenueTypeHow a company's revenue figure was determined.
- SubsidiaryTypeHow a subsidiary relates to its parent company.
- TrialRoleThe part an HCP played on a clinical trial, as recorded on the trial itself.
- TrialStatusA clinical trial's current recruitment status, as of the latest healthcare data delivery.