Provenance Domain - Revision history

Lorikrammer: /* Provenance Domain (provenance_domain) */

2026-04-14T20:58:06Z

Provenance Domain (provenance_domain)

← Older revision		Revision as of 20:58, 14 April 2026
Line 2:		Line 2:
	== Provenance Domain ''(provenance_domain)'' ==		== Provenance Domain ''(provenance_domain)'' ==

	This section defines the fields of the ''provenance_domain'' part of the [[~~Bco-domains~~\|BCO]] structure. The provenance domain IEEE schema and definition can be found [https://opensource.ieee.org/2791-object/ieee-2791-schema/-/blob/master/provenance_domain.json here].		This section defines the fields of the ''provenance_domain'' part of the [[BCO Domains\|BCO]] structure. The provenance domain IEEE schema and definition can be found [https://opensource.ieee.org/2791-object/ieee-2791-schema/-/blob/master/provenance_domain.json here].

	Condensed example:		Condensed example:

Lorikrammer at 20:50, 14 April 2026

2026-04-14T20:50:38Z

← Older revision		Revision as of 20:50, 14 April 2026
Line 1:		Line 1:
	'''Go back to [[~~Bco-domains\|~~BCO ~~domains~~]].'''		'''Go back to [[BCO Domains]].'''
	== Provenance Domain ''(provenance_domain)'' ==		== Provenance Domain ''(provenance_domain)'' ==

Lorikrammer: /* Provenance Domain (provenance_domain) */

2026-03-03T21:08:12Z

Provenance Domain (provenance_domain)

← Older revision		Revision as of 21:08, 3 March 2026
Line 2:		Line 2:
	== Provenance Domain ''(provenance_domain)'' ==		== Provenance Domain ''(provenance_domain)'' ==

	This section defines the fields of the provenance_domain part of the [[Bco-domains\|BCO]] structure. The provenance domain IEEE schema and definition can be found [https://opensource.ieee.org/2791-object/ieee-2791-schema/-/blob/master/provenance_domain.json here].		This section defines the fields of the ''provenance_domain'' part of the [[Bco-domains\|BCO]] structure. The provenance domain IEEE schema and definition can be found [https://opensource.ieee.org/2791-object/ieee-2791-schema/-/blob/master/provenance_domain.json here].

	Condensed example:		Condensed example:

Lorikrammer: /* Provenance Domain (provenance_domain) */

2026-03-03T20:35:19Z

Provenance Domain (provenance_domain)

← Older revision		Revision as of 20:35, 3 March 2026
Line 1:		Line 1:
	'''Go back to [[Bco-domains\|BCO domains]].'''		'''Go back to [[Bco-domains\|BCO domains]].'''
	== Provenance Domain (''provenance_domain'') ==		== Provenance Domain ''(provenance_domain)'' ==

	This section defines the fields of the provenance_domain part of the [[Bco-domains\|BCO]] structure. The provenance domain IEEE schema and definition can be found [https://opensource.ieee.org/2791-object/ieee-2791-schema/-/blob/master/provenance_domain.json here].		This section defines the fields of the provenance_domain part of the [[Bco-domains\|BCO]] structure. The provenance domain IEEE schema and definition can be found [https://opensource.ieee.org/2791-object/ieee-2791-schema/-/blob/master/provenance_domain.json here].
Line 59:		Line 59:
	== Domain Components ==		== Domain Components ==

	=== Name (''name'') ===		=== Name ''(name)'' ===

	Name for the BCO. This public field should take free text value using common biological research terminology supporting the terminology used in the usability_domain, external references (xref), and keywords sections. It is recommended that BCO names be short and easily recognizable. They should also not use special characters (spell things out). This field is '''required'''.		Name for the BCO. This public field should take free text value using common biological research terminology supporting the terminology used in the usability_domain, external references (xref), and keywords sections. It is recommended that BCO names be short and easily recognizable. They should also not use special characters (spell things out). This field is '''required'''.
Line 65:		Line 65:
	"name": "HCV1a ledipasvir resistance SNP detection"		"name": "HCV1a ledipasvir resistance SNP detection"

	=== Version (''version'') ===		=== Version ''(version)'' ===

	Records the versioning of this BCO instance object. This field is '''required'''.		Records the versioning of this BCO instance object. This field is '''required'''.
Line 80:		Line 80:
	"version": "2.1",		"version": "2.1",

	=== Review (''review'') ===		=== Review ''(review)'' ===

	This is an array to hold reviewer identifiers and a description of the status of an object in the review process. The subtype reviewer contains field(s) for name, affiliation, email, and the contribution type of the reviewer. To further record author information, ORCIDs are included as they allow for the author to curate their information after submission. ORCID identifiers must be valid and must have the prefix https://orcid.org/. The contribution type is a choice taken from PAV ontology: provenance, authoring and versioning, which also maps to the [https://www.w3.org/TR/prov-o/ PROV-O].		This is an array to hold reviewer identifiers and a description of the status of an object in the review process. The subtype reviewer contains field(s) for name, affiliation, email, and the contribution type of the reviewer. To further record author information, ORCIDs are included as they allow for the author to curate their information after submission. ORCID identifiers must be valid and must have the prefix https://orcid.org/. The contribution type is a choice taken from PAV ontology: provenance, authoring and versioning, which also maps to the [https://www.w3.org/TR/prov-o/ PROV-O].
Line 120:		Line 120:
	]		]

	=== Inheritance/derivation (''derived_from'') ===		=== Inheritance/derivation ''(derived_from)'' ===

	If the object is derived from another, this field will specify the parent object, in the form of the ‘object_id’. If the object is novel then the field is not included.		If the object is derived from another, this field will specify the parent object, in the form of the ‘object_id’. If the object is novel then the field is not included.
Line 126:		Line 126:
	"derived_from" : "https://example.com/BCO_948701/1.0"		"derived_from" : "https://example.com/BCO_948701/1.0"

	=== Obsolescence (''obsolete_after'') ===		=== Obsolescence ''(obsolete_after)'' ===

	If the object has an expiration date this field will specify that using the ‘datetime’ type which is in ISO-8601 format as clarified by W3C https://www.w3.org/TR/NOTE-datetime. This field is optional.		If the object has an expiration date this field will specify that using the ‘datetime’ type which is in ISO-8601 format as clarified by W3C https://www.w3.org/TR/NOTE-datetime. This field is optional.
Line 132:		Line 132:
	"obsolete_after" : "2118-09-26T14:43:43-0400"		"obsolete_after" : "2118-09-26T14:43:43-0400"

	=== Embargo (''embargo'') ===		=== Embargo ''(embargo)'' ===

	If the object has a period of time that it is not public, that range can be specified using these fields. Using the datetime type, a start and end time are specified for the embargo. These fields are optional.		If the object has a period of time that it is not public, that range can be specified using these fields. Using the datetime type, a start and end time are specified for the embargo. These fields are optional.
Line 141:		Line 141:
	},		},

	=== Created (''created'') ===		=== Created ''(created)'' ===

	Using the datetime type the time of initial creation of the BCO is recorded in ISO-8601 format as clarified by W3C https://www.w3.org/TR/NOTE-datetime. This field should be 'read only' and is '''required'''.		Using the datetime type the time of initial creation of the BCO is recorded in ISO-8601 format as clarified by W3C https://www.w3.org/TR/NOTE-datetime. This field should be 'read only' and is '''required'''.
Line 147:		Line 147:
	"created": "2017-01-20T09:40:17-0500"		"created": "2017-01-20T09:40:17-0500"

	=== Modification (''modified'') ===		=== Modification ''(modified)'' ===

	Using the datetime type the time of the most recent modification of the BCO is recorded. This field is '''required'''.		Using the datetime type the time of the most recent modification of the BCO is recorded. This field is '''required'''.
Line 153:		Line 153:
	"modified": "2018-03-21T18:31:48-0400"		"modified": "2018-03-21T18:31:48-0400"

	=== Contributors (''contributors'') ===		=== Contributors ''(contributors)'' ===

	This is a list to hold contributor identifiers and a description of their type of contribution, including a field for ORCIDs to record author information, as they allow for the author to curate their information after submission. ORCID identifiers must be [https://support.orcid.org/hc/en-us/articles/360006897674-Structure-of-the-ORCID-Identifier valid] and must have the prefix https://orcid.org/. The contribution type is a choice taken from [http://pav-ontology.github.io/pav/pav.rdf PAV ontology]: provenance, authoring and versioning, which also maps to the [https://www.w3.org/TR/prov-o/ PROV-O]. This field is '''required'''.		This is a list to hold contributor identifiers and a description of their type of contribution, including a field for ORCIDs to record author information, as they allow for the author to curate their information after submission. ORCID identifiers must be [https://support.orcid.org/hc/en-us/articles/360006897674-Structure-of-the-ORCID-Identifier valid] and must have the prefix https://orcid.org/. The contribution type is a choice taken from [http://pav-ontology.github.io/pav/pav.rdf PAV ontology]: provenance, authoring and versioning, which also maps to the [https://www.w3.org/TR/prov-o/ PROV-O]. This field is '''required'''.
Line 175:		Line 175:
	</pre>		</pre>

	=== License (''license'') ===		=== License ''(license)'' ===

	A space for Creative Commons license or other license information (text). The default or recommended license can be Creative Commons Attribution 4.0 International identified as https://spdx.org/licenses/CC-BY-4.0.html. This field is '''required'''.		A space for Creative Commons license or other license information (text). The default or recommended license can be Creative Commons Attribution 4.0 International identified as https://spdx.org/licenses/CC-BY-4.0.html. This field is '''required'''.

	"license": "https://spdx.org/licenses/CC-BY-4.0.html"		"license": "https://spdx.org/licenses/CC-BY-4.0.html"

Lorikrammer: Created page with "'''Go back to BCO domains.''' == Provenance Domain (''provenance_domain'') == This section defines the fields of the provenance_domain part of the BCO structure. The provenance domain IEEE schema and definition can be found [https://opensource.ieee.org/2791-object/ieee-2791-schema/-/blob/master/provenance_domain.json here]. Condensed example:

     "provenance_domain": {             "name": "HCV1a ledipasvir resistance SNP detection"..."

2026-02-10T21:30:11Z

Created page with "'''Go back to BCO domains.''' == Provenance Domain (''provenance_domain'') == This section defines the fields of the provenance_domain part of the BCO structure. The provenance domain IEEE schema and definition can be found [https://opensource.ieee.org/2791-object/ieee-2791-schema/-/blob/master/provenance_domain.json here]. Condensed example: <pre> "provenance_domain": { "name": "HCV1a ledipasvir resistance SNP detection"..."

New page

'''Go back to [[Bco-domains|BCO domains]].'''
== Provenance Domain (''provenance_domain'') ==

This section defines the fields of the provenance_domain part of the [[Bco-domains|BCO]] structure. The provenance domain IEEE schema and definition can be found [https://opensource.ieee.org/2791-object/ieee-2791-schema/-/blob/master/provenance_domain.json here].

Condensed example:
<pre>
"provenance_domain": {
"name": "HCV1a ledipasvir resistance SNP detection",
"version": "2.9",
"review": [
],
"obsolete_after" : "2118-09-26T14:43:43-0400",
"embargo" : {
},
"created": "2017-01-24T09:40:17-0500",
"modified": "2018-09-21T14:06:14-0400",
"contributors": [
],
"license": "https://spdx.org/licenses/CC-BY-4.0.html"
},
</pre>
{| class="wikitable"
|+Required Components of the Provenance Domain
!Field
!Required
|-
|name
|'''REQUIRED'''
|-
|version
|'''REQUIRED'''
|-
|review
|NOT REQUIRED
|-
|derived_from
|NOT REQUIRED
|-
|obsolete_after
|NOT REQUIRED
|-
|embargo
|NOT REQUIRED
|-
|created
|'''REQUIRED'''
|-
|modified
|'''REQUIRED'''
|-
|contributors
|'''REQUIRED'''
|-
|license
|'''REQUIRED'''
|}

== Domain Components ==

=== Name (''name'') ===

Name for the BCO. This public field should take free text value using common biological research terminology supporting the terminology used in the usability_domain, external references (xref), and keywords sections. It is recommended that BCO names be short and easily recognizable. They should also not use special characters (spell things out). This field is '''required'''.

"name": "HCV1a ledipasvir resistance SNP detection"

=== Version (''version'') ===

Records the versioning of this BCO instance object. This field is '''required'''.

[https://semver.org/ Semantic Versioning 2.0.0] describes versioning as follows:

Given a version number MAJOR.MINOR.PATCH, increment the:
1. MAJOR version when you make incompatible API changes,
2. MINOR version when you add functionality in a backward-compatible manner, and
3. PATCH version when you make backward-compatible bug fixes. Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

BCO versioning should adhere to semantic versioning. Given the above conditions, a MAJOR version would qualify for a new BCO, and therefore it is recommended that the versioning of a BCO only utilize MINOR and PATCH, or two digits.

"version": "2.1",

=== Review (''review'') ===

This is an array to hold reviewer identifiers and a description of the status of an object in the review process. The subtype reviewer contains field(s) for name, affiliation, email, and the contribution type of the reviewer. To further record author information, ORCIDs are included as they allow for the author to curate their information after submission. ORCID identifiers must be valid and must have the prefix https://orcid.org/. The contribution type is a choice taken from PAV ontology: provenance, authoring and versioning, which also maps to the [https://www.w3.org/TR/prov-o/ PROV-O].

The “status” key describes the status of an object in the review process and the following are the possible values:

*unreviewed flag indicates that the object has been submitted, but no further evaluation or verification has occurred.
*in-review flag indicates that verification is underway.
*approved flag indicates that the BCO has been verified and reviewed.
*suspended flag indicates an object that was once valid is no longer considered valid.
*rejected flag indicates that an error or inconsistency was detected in the BCO, and it has been removed or rejected.

The fields from the contributor object are used to populate the reviewer section. Though not required, it is strongly recommended that each BCO have at least one review (ideally by someone not listed with createdBy or authoredBy) upon publication.

"review": [
{
"status": "approved",
"reviewer_comment": "Approved by GW staff. Waiting for approval from FDA Reviewer",
"date": "2017-11-12T12:30:48-0400",
"reviewer": {
"name": "Charles Hadley King",
"affiliation": "George Washington University",
"email": "hadley_king@gwu.edu",
"contribution": "curatedBy",
"orcid": "https://orcid.org/0000-0003-1409-4549"
}
},
{
"status": "approved",
"reviewer_comment": "The revised BCO looks fine",
"date": "2017-12-12T12:30:48-0400",
"reviewer": {
"name": "Eric Donaldson",
"affiliation": "FDA",
"email": "Eric.Donaldson@fda.hhs.gov",
"contribution": "curatedBy"
}
}
]

=== Inheritance/derivation (''derived_from'') ===

If the object is derived from another, this field will specify the parent object, in the form of the ‘object_id’. If the object is novel then the field is not included.

"derived_from" : "https://example.com/BCO_948701/1.0"

=== Obsolescence (''obsolete_after'') ===

If the object has an expiration date this field will specify that using the ‘datetime’ type which is in ISO-8601 format as clarified by W3C https://www.w3.org/TR/NOTE-datetime. This field is optional.

"obsolete_after" : "2118-09-26T14:43:43-0400"

=== Embargo (''embargo'') ===

If the object has a period of time that it is not public, that range can be specified using these fields. Using the datetime type, a start and end time are specified for the embargo. These fields are optional.

"embargo" : {
"start_time": "2000-09-26T14:43:43-0400",
"end_time": "2000-09-26T14:43:45-0400"
},

=== Created (''created'') ===

Using the datetime type the time of initial creation of the BCO is recorded in ISO-8601 format as clarified by W3C https://www.w3.org/TR/NOTE-datetime. This field should be 'read only' and is '''required'''.

"created": "2017-01-20T09:40:17-0500"

=== Modification (''modified'') ===

Using the datetime type the time of the most recent modification of the BCO is recorded. This field is '''required'''.

"modified": "2018-03-21T18:31:48-0400"

=== Contributors (''contributors'') ===

This is a list to hold contributor identifiers and a description of their type of contribution, including a field for ORCIDs to record author information, as they allow for the author to curate their information after submission. ORCID identifiers must be [https://support.orcid.org/hc/en-us/articles/360006897674-Structure-of-the-ORCID-Identifier valid] and must have the prefix https://orcid.org/. The contribution type is a choice taken from [http://pav-ontology.github.io/pav/pav.rdf PAV ontology]: provenance, authoring and versioning, which also maps to the [https://www.w3.org/TR/prov-o/ PROV-O]. This field is '''required'''.
<pre>
"contributors": [
{
"name": "Charles Hadley King",
"affiliation": "George Washington University",
"email": "hadley_king@gwu.edu",
"contribution": ["createdBy", "curatedBy"],
"orcid": "https://orcid.org/0000-0003-1409-4549"
},

{
"name": "Eric Donaldson",
"affiliation": "FDA",
"email": "Eric.Donaldson@fda.hhs.gov",
"contribution": ["authoredBy"]
}
]
</pre>

=== License (''license'') ===

A space for Creative Commons license or other license information (text). The default or recommended license can be Creative Commons Attribution 4.0 International identified as https://spdx.org/licenses/CC-BY-4.0.html. This field is '''required'''.

"license": "https://spdx.org/licenses/CC-BY-4.0.html"