wcmc-its / ReCiter-Identity-Model

ReCiter-Identity-Model
0 stars 3 forks source link

Update data model to include ORCID, visibility, profileURL, headshot, start/end date for org affiliations, and isPrimary for institutions and org units #1

Open paulalbert1 opened 5 years ago

paulalbert1 commented 5 years ago

Summary

  1. Add "orcid" attribute. User can have 1 ORCID IDs.
  2. Add "visibility" attribute. Use ENUMs. Options are public, institution, department, and private.
  3. Add "profileURL" attribute. Can be clinical, research, and directory.
  4. Add "headshot" attribute.
  5. Add start and end date for org affiliations.
  6. Add isPrimary attribute for organizational units.
  7. Add isPrimary attribute for org affiliations.

Remaining questions

  1. Should we get rid of pubMedAlias? Having this in there when it's not being used is confusing.
  2. Should we qualify the source? For example, we could have an optional attribute called "source." This will be useful once we start adding to the identity record based on feedback we get from the Disambiguation Profile view.
  3. Should this apply to master branch? For simplicity's sake I would say yes.
  4. Add h-index?

Example

{
  "identity": {
    "alternateNames": [
      {
        "firstInitial": "P",
        "firstName": "Paul",
        "lastName": "Albert",
        "middleInitial": "J",
        "middleName": "J."
      },
      {
        "firstInitial": "P",
        "firstName": "Paul",
        "lastName": "Albert"
      }
    ],
    "degreeYear": {
      "bachelorYear": 1997,
      "doctoralYear": 0
    },
    "emails": [
      "paa2013@med.cornell.edu",
      "palbert1@gmail.com"
    ],
    "grants": [
      "RR029822"
    ],
    "headshot": [
      "https://directory.weill.cornell.edu/api/v1/person/profile/paa2013.png"
    ],    
    "institutions": [
      {
        "institution": {
          "institutionName": "Weill Cornell Medical College, Cornell University",
          "isPrimary": "TRUE"
        },
      {
        "institution": {
          "institutionName": "Columbia University, Teachers College",
          "isPrimary": "FALSE"
        }
        }
    ],
    "knownRelationships": [
      {
        "name": {
          "firstInitial": "M",
          "firstName": "Mark",
          "lastName": "Bronnimann"
        },
        "type": "CO_INVESTIGATOR",
        "uid": "meb2001"
      },
      {
        "name": {
          "firstInitial": "E",
          "firstName": "Eliza",
          "lastName": "Chan"
        },
        "type": "CO_INVESTIGATOR",
        "uid": "elc2013"
      },
      {
        "name": {
          "firstInitial": "M",
          "firstName": "Michael",
          "lastName": "Bales",
          "middleInitial": "E",
          "middleName": "Eliot"
        },
        "type": "HR",
        "uid": "meb7002"
      }
    ],
    "orcid": "https://orcid.org/0000-0001-6177-6839",
    "organizationalUnits": [
      {
        "organizationalUnitLabel": "Library",
        "organizationalUnitType": "DEPARTMENT",
        "organizationalUnitStartDate": "2012-05-01",
        "organizationalUnitEndDate": "2018-01-01"        
      },
      {
        "organizationalUnitLabel": "ITS",
        "organizationalUnitType": "DEPARTMENT",
        "organizationalUnitStartDate": "2001-01-01",
        "organizationalUnitEndDate": ""
      }
    ],
    "personTypes": [
      "academic",
      "academic-faculty",
      "academic-faculty-associate",
      "academic-faculty-weillfulltime",
      "employee-academic",
      "employee-exempt",
      "employee",
      "affiliate",
      "affiliate-federated",
      "affiliate-federated-affiliate"
    ],
    "primaryName": {
      "firstInitial": "P",
      "firstName": "Paul",
      "lastName": "Albert",
      "middleInitial": "J",
      "middleName": "J"
    },
    "profileURL": [
      {
        "URL": "https://directory.weill.cornell.edu/person/profile/paa2013",
        "type": "DIRECTORY"     
      },
      {
        "URL": "http://vivo.med.cornell.edu/individual/cwid-paa2013",
        "type": "RESEARCH"     
      },
      {
        "URL": "https://weillcornell.org/hfwildman",
        "type": "CLINICAL"     
      },            
      {
        "organizationalUnitLabel": "ITS",
        "type": "DEPARTMENT",
        "startDate": "2001-01-01",
        "endDate": "",
        "isPrimary":"TRUE"
      }
    ],
    "pubMedAlias": [],
    "title": "Associate Librarian",
    "uid": "paa2013",    
    "visibility": "public"
  },
  "uid": "paa2013"
}