Skip to content

fix issue-582, align Person and Contact entities #669

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BrapiCoordinatorSelby merged 1 commit into from
Jun 4, 2026
Merged

fix issue-582, align Person and Contact entities #669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 34 additions & 48 deletions Specification/BrAPI-Schema/BrAPI-Core/Contact.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,56 +1,42 @@
{
"$defs": {
"Contact": {
"properties": {
"contactDbId": {
"description": "The ID which uniquely identifies this contact\n\nMIAPPE V1.1 (DM-33) Person ID - An identifier for the data submitter. If that submitter is an individual, ORCID identifiers are recommended.",
"type": "string"
"allOf": [
{
"$ref": "Person.json#/$defs/Person"
},
"email": {
"description": "The contacts email address\n\nMIAPPE V1.1 (DM-32) Person email - The electronic mail address of the person.",
"type": [
"null",
"string"
]
},
"instituteName": {
"description": "The name of the institution which this contact is part of\n\nMIAPPE V1.1 (DM-35) Person affiliation - The institution the person belongs to",
"type": [
"null",
"string"
]
},
"name": {
"description": "The full name of this contact person\n\nMIAPPE V1.1 (DM-31) Person name - The name of the person (either full name or as used in scientific publications)",
"type": [
"null",
"string"
]
},
"orcid": {
"description": "The Open Researcher and Contributor ID for this contact person (orcid.org)\n\nMIAPPE V1.1 (DM-33) Person ID - An identifier for the data submitter. If that submitter is an individual, ORCID identifiers are recommended.",
"type": [
"null",
"string"
]
},
"type": {
"description": "The type of person this contact represents (ex: Coordinator, Scientist, PI, etc.)\n\nMIAPPE V1.1 (DM-34) Person role - Type of contribution of the person to the investigation",
"type": [
"null",
"string"
]
{
"properties": {
"contactDbId": {
"description": "**Deprecated in v2.2** Please use `personDbId`. Github issue number #582 <br> The ID which uniquely identifies this contact\n\nMIAPPE V1.1 (DM-33) Person ID - An identifier for the data submitter. If that submitter is an individual, ORCID identifiers are recommended.",
"type": "string"
},
"email": {
"description": "**Deprecated in v2.2** Please use `emailAddress`. Github issue number #582 <br> The contacts email address\n\nMIAPPE V1.1 (DM-32) Person email - The electronic mail address of the person.",
"type": [
"null",
"string"
]
},
"name": {
"description": "**Deprecated in v2.2** Please use `firstName`, `middleName`, and `lastName`. Github issue number #582 <br> The full name of this contact person\n\nMIAPPE V1.1 (DM-31) Person name - The name of the person (either full name or as used in scientific publications)",
"type": [
"null",
"string"
]
}
},
"required": [
"personDbId"
],
"type": "object",
"title": "Contact",
"description": "A persons contact information",
"brapi-metadata": {
"primaryModel": false
}
}
},
"required": [
"contactDbId"
],
"type": "object",
"title": "Contact",
"description": "A persons contact information",
"brapi-metadata": {
"primaryModel": false
}
]
}
},
"$id": "https://brapi.org/Specification/BrAPI-Schema/BrAPI-Core/Contact.json",
Expand Down
42 changes: 42 additions & 0 deletions Specification/BrAPI-Schema/BrAPI-Core/Person.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,13 @@
"string"
]
},
"instituteName": {
"description": "The name of the institution which this person is part of\n\nMIAPPE V1.1 (DM-35) Person affiliation - The institution the person belongs to",
"type": [
"null",
"string"
]
},
"lastName": {
"description": "Persons last name",
"type": [
Expand All @@ -66,6 +73,13 @@
"description": "Unique ID for a person",
"type": "string"
},
"personName": {
"description": "The full name of a person",
"type": [
"null",
"string"
]
},
"phoneNumber": {
"description": "phone number of this person",
"type": [
Expand All @@ -80,6 +94,20 @@
"string"
]
},
"orcid": {
"description": "The Open Researcher and Contributor ID for this person (orcid.org)\n\nMIAPPE V1.1 (DM-33) Person ID - An identifier for the data submitter. If that submitter is an individual, ORCID identifiers are recommended.",
"type": [
"null",
"string"
]
},
"type": {
"description": "The type of person this represents (ex: Coordinator, Scientist, PI, etc.)\n\nMIAPPE V1.1 (DM-34) Person role - Type of contribution of the person to the investigation",
"type": [
"null",
"string"
]
},
"lists": {
"title": "Lists",
"description": "",
Expand Down Expand Up @@ -107,6 +135,20 @@
"null",
"array"
]
},
"observations": {
"title": "Observations",
"description": "Observations uploaded by a person",
"referencedAttribute": "uploadedByPerson",
"relationshipType": "one-to-many",
"items": {
"$ref": "../BrAPI-Phenotyping/Observation.json#/$defs/Observation",
"description": "Observation"
},
"type": [
"null",
"array"
]
}
},
"required": [
Expand Down
15 changes: 14 additions & 1 deletion Specification/BrAPI-Schema/BrAPI-Phenotyping/Observation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,21 @@
}
]
},
"uploadedByPerson": {
"description": "The user or person who uploaded the observation to the database system",
"referencedAttribute": "observations",
"relationshipType": "many-to-one",
"anyOf": [
{
"$ref": "../BrAPI-Core/Person.json#/$defs/Person"
},
{
"type": "null"
}
]
},
"uploadedBy": {
"description": "The name or id of the user who uploaded the observation to the database system",
"description": "**Deprecated in v2.2** Please use `uploadedByPersonDbId` or `uploadedByPersonName`. Github issue number #582 <br> The name or id of the user who uploaded the observation to the database system",
"type": [
"null",
"string"
Expand Down
11 changes: 11 additions & 0 deletions Specification/BrAPI-Schema/Requests/TrialRequest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,17 @@
"example": true
},
"contactDbIds": {
"description": "**Deprecated in v2.2** Please use `contactPersonDbIds`. Github issue number #582 <br> List of contact entities associated with this trial",
"type": "array",
"items": {
"type": "string"
},
"example": [
"e0f70c2a",
"b82f0967"
]
},
"contactPersonDbIds": {
"description": "List of contact entities associated with this trial",
"type": "array",
"items": {
Expand Down
Loading