Skip to content
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

Jump to bottom

CDC DDI-C: Creator identifier (e.g. ORCID) #162

Closed
katja-moilanen opened this issue Feb 16, 2024 · 4 comments · Fixed by #202
Closed

CDC DDI-C: Creator identifier (e.g. ORCID) #162

katja-moilanen opened this issue Feb 16, 2024 · 4 comments · Fixed by #202
Assignees
@katja-moilanen
Milestone
3.0.0 CDC DDI-C

Comments

@katja-moilanen
Copy link
Contributor

katja-moilanen commented Feb 16, 2024 •
edited
Loading

cessda/cessda.cdc.versions#290

DDI-C 1.2.2: and DDI-C 2.5:

codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink
codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink/@URI
codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink/@title

Example:

<AuthEnty>Moilanen, Katja
<ExtLink URI="https://orcid.org/0000-0002-7668-5427" role="PID" title="ORCID">0000-0002-7668-5427</ExtLink>
</AuthEnty>

This not a perfect solution, but good enough.

DDI-C 2.6 draft:

 codeBook/stdyDscr/citation/rspStmt/AuthEnty/@personalID
 codeBook/stdyDscr/citation/rspStmt/AuthEnty/@typeOfPersonalID

Example:

<AuthEnty personalID="0000-0002-7668-5427" typeOfPersonalID="ORCID">Moilanen, Katja</AuthEnty>
Closed
@katja-moilanen katja-moilanen mentioned this issue Sep 23, 2024
Open
@katja-moilanen katja-moilanen added this to the 3.0.0 CDC DDI-C milestone Oct 11, 2024
@katja-moilanen
Copy link
Contributor Author

katja-moilanen commented Oct 14, 2024 •
edited
Loading

DDI1.2.2+DDI2.5 and DDI2.6
OPTIONAL //AuthEnty/ExtLink and //AuthEnty/@personalID (includes the PID)
OPTIONAL //AuthEnty/ExtLink/@title and //AuthEnty/@typeOfPersonalID (includes the type of the PID e.g. ORCID)

Only DDI1.2.2 and DDI2.5
MANDATORY, IF PARENT PRESENT (because of the DDI-C spec) //AuthEnty/ExtLink/@URI (includes the URL for the PID)

Optional/recommended/mandatory info from CDC SO 23.10.2024.

@katja-moilanen katja-moilanen self-assigned this Oct 14, 2024
@katja-moilanen
Copy link
Contributor Author

katja-moilanen commented Oct 22, 2024 •
edited
Loading

DDI2.5

    <pr:Used xpath="/ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:rspStmt/ddi:AuthEnty/ddi:ExtLink" isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: No</r:Content>
            <r:Content>Usage: The persistent identifier (PID) of the principal investigator/creator</r:Content>
            <r:Content>CDC_UI_Label: Creator</r:Content>
            <r:Content>CMM_Mapping: 2.4</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
			<Constraints>
				<OptionalNodeConstraint/>
			</Constraints>
			]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:rspStmt/ddi:AuthEnty/ddi:ExtLink/@URI"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Mandatory if '..../ddi:AuthEnty/ddi:ExtLink' element is present.</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: The URL of the PID. Please note, that the URI attribute is mandatory for the ExtLink element due to the DDI-C specification.</r:Content>
	        <r:Content>CDC_UI_Label: Creator</r:Content>
            <r:Content>CMM_Mapping: 2.4.2</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content> <![CDATA[
                <Constraints>
                    <MandatoryNodeIfParentPresentConstraint/>
                </Constraints>
                ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:rspStmt/ddi:AuthEnty/ddi:ExtLink/@title" isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: The type of the PID. If the PID is documented, the type of the PID should be documented, too.</r:Content>
            <r:Content>CDC_UI_Label: Creator</r:Content>
            <r:Content>CMM_Mapping: 2.4.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
			<Constraints>
				<OptionalNodeConstraint/>
			</Constraints>
			]]></r:Content>
        </pr:Instructions>
    </pr:Used>

@katja-moilanen
Copy link
Contributor Author

katja-moilanen commented Oct 22, 2024 •
edited
Loading

DDI1.2.2

    <pr:Used xpath="/ddi:codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink" isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: No</r:Content>
            <r:Content>Usage: The persistent identifier (PID) of the principal investigator/creator</r:Content>
            <r:Content>CDC_UI_Label: Creator</r:Content>
            <r:Content>CMM_Mapping: 2.4</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
			<Constraints>
				<OptionalNodeConstraint/>
			</Constraints>
			]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/ddi:codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink/@URI"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Mandatory if '..../AuthEnty/ExtLink' element is present.</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: The URL of the PID. Please note, that the URI attribute is mandatory for the ExtLink element due to the DDI-C specification.</r:Content>
	        <r:Content>CDC_UI_Label: Creator</r:Content>
            <r:Content>CMM_Mapping: 2.4.2</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content> <![CDATA[
                <Constraints>
                    <MandatoryNodeIfParentPresentConstraint/>
                </Constraints>
                ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/ddi:codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink/@title" isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: The type of the PID.  If the PID is documented, the type of the PID should be documented, too.</r:Content>
            <r:Content>CDC_UI_Label: Creator</r:Content>
            <r:Content>CMM_Mapping: 2.4.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
			<Constraints>
				<OptionalNodeConstraint/>
			</Constraints>
			]]></r:Content>
        </pr:Instructions>
    </pr:Used>

@katja-moilanen
Copy link
Contributor Author

katja-moilanen commented Oct 22, 2024 •
edited
Loading

DDI2.6

    <pr:Used xpath="/ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:rspStmt/ddi:AuthEnty/@personalID" isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: The persistent identifier (PID) of the principal investigator/creator</r:Content>
            <r:Content>CDC_UI_Label: Creator</r:Content>
            <r:Content>CMM_Mapping: 2.4</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
			<Constraints>
				<OptionalNodeConstraint/>
			</Constraints>
			]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:rspStmt/ddi:AuthEnty/@typeOfPersonalID" isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: The type of the PID. If the PID is documented, the type of the PID should be documented, too</r:Content>
            <r:Content>CDC_UI_Label: Creator</r:Content>
            <r:Content>CMM_Mapping: 2.4.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
			<Constraints>
				<OptionalNodeConstraint/>
			</Constraints>
			]]></r:Content>
        </pr:Instructions>
    </pr:Used>

@katja-moilanen katja-moilanen changed the title CDC: Creator identifier (e.g. ORCID) CDC DDI-C: Creator identifier (e.g. ORCID) Oct 23, 2024
katja-moilanen added a commit that referenced this issue Oct 23, 2024
@katja-moilanen
#162 CDC DDI-C added PID fields for the creator
4e25cd4
@katja-moilanen katja-moilanen linked a pull request Oct 23, 2024 that will close this issue
#162 CDC DDI-C added PID fields for the creator #202
Merged
katja-moilanen added a commit that referenced this issue Oct 23, 2024
@katja-moilanen
#162 CDC DDI-C added PID fields for the creator (#202)
e48b622
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@katja-moilanen katja-moilanen

Labels
None yet
Projects
None yet
Milestone
3.0.0 CDC DDI-C
Development

Successfully merging a pull request may close this issue.

#162 CDC DDI-C added PID fields for the creator cessda/cessda.metadata.profiles
1 participant
@katja-moilanen