Provenance

Description

We adapted the Provenance resource to collect information how data was collected - manually v.s. automatically - and the activities related to a resource - e.g., when it was uploaded, when it was published, when it was updated, etc. - and the persons or devices involved. The Provenance elements of NFDI4Health are inspired by ClinicalTrials.gov

Title Canonical
NFDI4Health PR MDS Provenance https://www.nfdi4health.de/fhir/metadataschema/StructureDefinition/nfdi4health-pr-mds-provenance

References

Reference direction Title Path
references to NFDI4Health PR MDS Study Provenance.target
references to NFDI4Health_PR MDS Document Provenance.target
references to NFDI4Health_PR MDS Questionnaire Provenance.target
references to NFDI4Health PR MDS Registry Provenance.target
references to NFDI4Health PR MDS Practitioner Provenance.agent.who
references to NFDI4Health PR MDS Practitioner Role Provenance.agent.who
references to NFDI4Health PR MDS Organization Provenance.agent.who

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ0..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
targetΣ I1..*Reference(NFDI4Health PR MDS Questionnaire | NFDI4Health PR MDS Document | NFDI4Health PR MDS Study | NFDI4Health PR MDS Registry)
occurredPeriodPeriod
occurredDateTimedateTime
recordedΣ1..1instant
policy0..*uri
locationI0..1Reference(Location)
reason0..*CodeableConceptBinding
activity1..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..1CodeableConceptBinding
role0..*CodeableConcept
whoΣ I1..1Reference(NFDI4Health PR MDS Practitioner | NFDI4Health PR MDS Practitioner Role | NFDI4Health PR MDS Organization)
onBehalfOfI0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
roleΣ1..1codeBinding
whatΣ I1..1Reference(Resource)
agent0..*see (agent)
signature0..*Signature
idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ0..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
targetΣ I1..*Reference(NFDI4Health PR MDS Questionnaire | NFDI4Health PR MDS Document | NFDI4Health PR MDS Study | NFDI4Health PR MDS Registry)
occurredPeriodPeriod
occurredDateTimedateTime
recordedΣ1..1instant
policy0..*uri
locationI0..1Reference(Location)
reason0..*CodeableConceptBinding
activity1..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..1CodeableConceptBinding
role0..*CodeableConcept
whoΣ I1..1Reference(NFDI4Health PR MDS Practitioner | NFDI4Health PR MDS Practitioner Role | NFDI4Health PR MDS Organization)
onBehalfOfI0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
roleΣ1..1codeBinding
whatΣ I1..1Reference(Resource)
agent0..*see (agent)
signature0..*Signature
idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ0..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
targetΣ I1..*Reference(NFDI4Health PR MDS Questionnaire | NFDI4Health PR MDS Document | NFDI4Health PR MDS Study | NFDI4Health PR MDS Registry)
occurredPeriodPeriod
occurredDateTimedateTime
recordedΣ1..1instant
policy0..*uri
locationI0..1Reference(Location)
reason0..*CodeableConceptBinding
activity1..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..1CodeableConceptBinding
role0..*CodeableConcept
whoΣ I1..1Reference(NFDI4Health PR MDS Practitioner | NFDI4Health PR MDS Practitioner Role | NFDI4Health PR MDS Organization)
onBehalfOfI0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
roleΣ1..1codeBinding
whatΣ I1..1Reference(Resource)
agent0..*see (agent)
signature0..*Signature
{
    "resourceType": "StructureDefinition",
    "id": "nfdi4health-pr-mds-provenance",
    "url": "https://www.nfdi4health.de/fhir/metadataschema/StructureDefinition/nfdi4health-pr-mds-provenance",
    "version": "0.9",
    "name": "NFDI4Health_PR_MDS_Provenance",
    "title": "NFDI4Health PR MDS Provenance",
    "status": "draft",
    "publisher": "NFDI4Health",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "https://www.nfdi4health.de"
                }
            ]
        }
    ],
    "description": "Profile to collect information how data was collected - manually v.s. automatically - and the activities related to a resource - e.g., when it was uploaded, when it was published, when it was updated, etc. - and the persons or devices involved.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "workflow",
            "uri": "http://hl7.org/fhir/workflow",
            "name": "Workflow Pattern"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w3c.prov",
            "uri": "http://www.w3.org/ns/prov",
            "name": "W3C PROV"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        },
        {
            "identity": "fhirauditevent",
            "uri": "http://hl7.org/fhir/auditevent",
            "name": "FHIR AuditEvent Mapping"
        },
        {
            "identity": "NFDI4Health",
            "name": "NFDI4Health to FHIR Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Provenance",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Provenance",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Provenance",
                "path": "Provenance",
                "short": "Provenance aspects of data entry",
                "definition": "Group of items providing information about provenance aspects of the data entry on this portal.",
                "mapping":  [
                    {
                        "identity": "NFDI4Health",
                        "map": "Resource.provenance"
                    }
                ]
            },
            {
                "id": "Provenance.meta.versionId",
                "path": "Provenance.meta.versionId",
                "short": "Version number",
                "definition": "Version number of the [RESOURCE] within the portal/system",
                "mapping":  [
                    {
                        "identity": "NFDI4Health",
                        "map": "Resource.provenance.resourceVersion"
                    }
                ]
            },
            {
                "id": "Provenance.target",
                "path": "Provenance.target",
                "definition": "The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://www.nfdi4health.de/fhir/metadataschema/StructureDefinition/nfdi4health-pr-mds-questionnaire",
                            "https://www.nfdi4health.de/fhir/metadataschema/StructureDefinition/nfdi4health-pr-mds-document",
                            "https://www.nfdi4health.de/fhir/metadataschema/StructureDefinition/nfdi4health-pr-mds-study",
                            "https://www.nfdi4health.de/fhir/metadataschema/StructureDefinition/nfdi4health-pr-mds-registry"
                        ]
                    }
                ]
            },
            {
                "id": "Provenance.recorded",
                "path": "Provenance.recorded",
                "short": "Last verified on | First submitted on | First posted/published on | Last update submitted on | Last update posted/published on",
                "definition": "For verification date: Date on which the responsible party last verified the information about the [RESOURCE], even if no additional or updated information is being submitted. | For first submission date: Date when the [RESOURCE] was first submitted for publication. | For first posted date: Date when the [RESOURCE] was first posted/published. | For last update submission date: Date when the last update of the [RESOURCE] was submitted for publication. | For last update posted date: Date when the last update of the [RESOURCE] was posted/published.",
                "mapping":  [
                    {
                        "identity": "NFDI4Health",
                        "map": "Resource.provenance.verificationDate"
                    },
                    {
                        "identity": "NFDI4Health",
                        "map": "Resource.provenance.firstSubmittedDate"
                    },
                    {
                        "identity": "NFDI4Health",
                        "map": "Resource.provenance.firstPostedDate"
                    },
                    {
                        "identity": "NFDI4Health",
                        "map": "Resource.provenance.lastUpdateSubmittedDate"
                    },
                    {
                        "identity": "NFDI4Health",
                        "map": "Resource.provenance.lastUpdatePostedDate"
                    }
                ]
            },
            {
                "id": "Provenance.activity",
                "path": "Provenance.activity",
                "min": 1,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://www.nfdi4health.de/fhir/metadataschema/ValueSet/nfdi4health-vs-mds-provenance-activity-hl7-local",
                    "description": "Value set defining codes for activity types."
                }
            },
            {
                "id": "Provenance.agent",
                "path": "Provenance.agent",
                "short": "Last verified by [USER] | First submitted by [USER] | First posted/published by [USER] | Last updated submitted by [USER] | Last update posted/published by [USER]",
                "definition": "For verification user: User who last verified the information about the [RESOURCE]. | For first submission user: User who first submitted the [RESOURCE] for publication. | For first posted user: User who first posted/published the [RESOURCE]. | For last update submission user: User who submitted the last update of the [RESOURCE]. | For last update posted user: User who posted/published the last update of the [RESOURCE].",
                "mapping":  [
                    {
                        "identity": "NFDI4Health",
                        "map": "Resource.provenance.verificationUser"
                    },
                    {
                        "identity": "NFDI4Health",
                        "map": "Resource.provenance.firstSubmittedUser"
                    },
                    {
                        "identity": "NFDI4Health",
                        "map": "Resource.provenance.firstPostedUser"
                    },
                    {
                        "identity": "NFDI4Health",
                        "map": "Resource.provenance.lastUpdateSubmittedUser"
                    },
                    {
                        "identity": "NFDI4Health",
                        "map": "Resource.provenance.lastUpdatePostedUser"
                    }
                ]
            },
            {
                "id": "Provenance.agent.who",
                "path": "Provenance.agent.who",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://www.nfdi4health.de/fhir/metadataschema/StructureDefinition/nfdi4health-pr-mds-practitioner",
                            "https://www.nfdi4health.de/fhir/metadataschema/StructureDefinition/nfdi4health-pr-mds-practitioner-role",
                            "https://www.nfdi4health.de/fhir/metadataschema/StructureDefinition/nfdi4health-pr-mds-organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

Example data for NFDI4Health PR MDS Provenance used to represent the source of data collection of resources.


Example of NFDI4Health PR MDS Provenance modelled to indicate that the metadata relating to the document 'Household Transmission Investigation Protocol for COVID-19' was automatically uploaded from ClinicalTrials.gov in NFDI4Health' Central Search Hub InstanceOfProvenanceAutomaticallyUploadedFromCTgov


Example of NFDI4Health PR MDS Provenance modelled to indicate that the metadata relating to the SHIP-Trend study was manually uploaded in NFDI4Health' Central Search Hub InstanceOfProvenanceManuallyCollectedSHIPTrend