{ "resourceType": "StructureDefinition", "id": "Provenance", "meta": { "lastUpdated": "2021-04-06T21:58:31.578+00:00" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category", "valueString": "Foundation.Security" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 3 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", "valueCode": "not-classified" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "sec" }, { "url": "http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status", "valueCode": "Provenance are recorded, there is no update or delete." } ], "url": "http://hl7.org/fhir/StructureDefinition/Provenance", "version": "4.6.0", "name": "Provenance", "status": "draft", "date": "2021-04-06T21:58:31.578+00:00", "publisher": "Health Level Seven International (Security)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/secure/index.cfm" } ] } ], "description": "Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.", "fhirVersion": "4.6.0", "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" } ], "kind": "resource", "abstract": false, "type": "Provenance", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource", "derivation": "specialization", "differential": { "element": [ { "id": "Provenance", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes", "valueString": "Sources of requirements: v2 EVN, Control Act, CDA, W3C provenance, ATNA." }, { "url": "http://hl7.org/fhir/build/StructureDefinition/svg", "valueCode": "0,0" } ], "path": "Provenance", "short": "Who, What, When for a set of resources", "definition": "Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.", "comment": "Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance.", "alias": [ "History", "Event", "Activity" ], "min": 0, "max": "*", "mapping": [ { "identity": "workflow", "map": "Event" }, { "identity": "rim", "map": "ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN]" }, { "identity": "w3c.prov", "map": "Activity" }, { "identity": "w5", "map": "infrastructure.information" } ] }, { "id": "Provenance.target", "path": "Provenance.target", "short": "Target Reference(s) (usually version specific)", "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.", "comment": "Target references are usually version specific, but might not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource might not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion.", "min": 1, "max": "*", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "rim", "map": "./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target OR ./participation[isNormalParticipation() and typeCode=SBJ]/role OR ./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player" }, { "identity": "fhirauditevent", "map": "AuditEvent.entity.reference" }, { "identity": "w3c.prov", "map": "Entity Created/Updated" } ] }, { "id": "Provenance.occurred[x]", "path": "Provenance.occurred[x]", "short": "When the activity occurred", "definition": "The period during which the activity occurred.", "comment": "The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.", "min": 0, "max": "1", "type": [ { "code": "Period" }, { "code": "dateTime" } ], "mapping": [ { "identity": "workflow", "map": "Event.occurred[x]" }, { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "rim", "map": "./effectiveTime[type=IVL_TS]" }, { "identity": "w3c.prov", "map": "Activity.startTime & Activity.endTime" } ] }, { "id": "Provenance.recorded", "path": "Provenance.recorded", "short": "When the activity was recorded / updated", "definition": "The instant of time at which the activity was recorded.", "comment": "This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource.", "min": 0, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.recorded" }, { "identity": "rim", "map": "unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS])" }, { "identity": "fhirauditevent", "map": "AuditEvent.recorded" }, { "identity": "w3c.prov", "map": "Activity.when" } ] }, { "id": "Provenance.policy", "path": "Provenance.policy", "short": "Policy or plan the activity was defined by", "definition": "Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.", "comment": "For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.", "min": 0, "max": "*", "type": [ { "code": "uri" } ], "mapping": [ { "identity": "rim", "map": "./inboundRelationship[isNormalActRelationship() and typeCode=\"SUBJ\"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel" }, { "identity": "fhirauditevent", "map": "AuditEvent.agent.policy" } ] }, { "id": "Provenance.location", "path": "Provenance.location", "short": "Where the activity occurred, if relevant", "definition": "Where the activity occurred, if relevant.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ] } ], "mapping": [ { "identity": "workflow", "map": "Event.location" }, { "identity": "w5", "map": "FiveWs.where[x]" }, { "identity": "rim", "map": "unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode=\"LOC\" and determinerCode=\"INST\"]" }, { "identity": "fhirauditevent", "map": "AuditEvent.agent.location" }, { "identity": "w3c.prov", "map": "Activity.location" } ] }, { "id": "Provenance.authorization", "path": "Provenance.authorization", "short": "Authorization (purposeOfUse) related to the event", "definition": "The authorization (e.g., PurposeOfUse) that was used during the event being recorded.", "requirements": "Record of any relevant security context, not restricted to purposeOfUse valueSet. May include security compartments, refrain, obligation, or other security tags.", "alias": [ "PurposeOfEvent" ], "min": 0, "max": "*", "type": [ { "code": "CodeableReference" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProvenanceReason" } ], "strength": "example", "description": "The authorized purposeOfUse for the activity.", "valueSet": "http://terminology.hl7.org/ValueSet/v3-PurposeOfUse" }, "mapping": [ { "identity": "workflow", "map": "Event.reasonCode" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": "unique(./reasonCode)" }, { "identity": "fhirauditevent", "map": "AuditEvent.purposeOfEvent" }, { "identity": "w3c.prov", "map": "Activity.Activity" } ] }, { "id": "Provenance.activity", "path": "Provenance.activity", "short": "Activity that occurred", "definition": "An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProvenanceActivity" } ], "strength": "extensible", "description": "The activity that took place.", "valueSet": "http://hl7.org/fhir/ValueSet/provenance-activity-type" }, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": "Act.code" }, { "identity": "fhirauditevent", "map": "AuditEvent.code" }, { "identity": "w3c.prov", "map": "Activity.Activity" } ] }, { "id": "Provenance.basedOn", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "path": "Provenance.basedOn", "short": "Workflow authorization within which this event occurred", "definition": "Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/DeviceRequest", "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation", "http://hl7.org/fhir/StructureDefinition/MedicationRequest", "http://hl7.org/fhir/StructureDefinition/NutritionOrder", "http://hl7.org/fhir/StructureDefinition/ServiceRequest", "http://hl7.org/fhir/StructureDefinition/Task" ] } ], "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": "Act.code" }, { "identity": "w3c.prov", "map": "Activity.Activity" } ] }, { "id": "Provenance.patient", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "path": "Provenance.patient", "short": "The patient is the subject of the data created/updated (.target) by the activity", "definition": "The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.", "requirements": "When the .patient is populated it shall be accurate to the subject of the target data. The .patient shall not be populated when the target data created/updated (.target) by the activity does not involve a subject. Note that when the patient is an agent, they will be recorded as an agent. When the Patient resource is Created, Updated, or Deleted it will be recorded as an entity.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] } ], "mapping": [ { "identity": "workflow", "map": "Event.patient" }, { "identity": "w5", "map": "FiveWs.subject" }, { "identity": "rim", "map": "participation[typeCode=RTGT]" }, { "identity": "w3c.prov", "map": "Entity.Identity" } ] }, { "id": "Provenance.encounter", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "path": "Provenance.encounter", "short": "Encounter within which this event occurred or which the event is tightly associated", "definition": "This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ], "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": "Act.code" }, { "identity": "w3c.prov", "map": "Activity.Activity" } ] }, { "id": "Provenance.agent", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/svg", "valueCode": "0,200" } ], "path": "Provenance.agent", "short": "Actor involved", "definition": "An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.", "comment": "Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.", "requirements": "An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer" }, { "identity": "w5", "map": "FiveWs.who" }, { "identity": "rim", "map": "./participation[isNormalParticipation()] OR ./outboundRelationship[isNormalActRelationship() and typeCode='DRIV']" }, { "identity": "fhirauditevent", "map": "AuditEvent.agent" }, { "identity": "w3c.prov", "map": "Agent" } ] }, { "id": "Provenance.agent.type", "path": "Provenance.agent.type", "short": "How the agent participated", "definition": "The Functional Role of the agent with respect to the activity.", "comment": "For example: assembler, author, prescriber, signer, investigator, etc.", "requirements": "Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProvenanceAgentType" } ], "strength": "example", "description": "The type of participation that a provenance agent played with respect to the activity.", "valueSet": "http://hl7.org/fhir/ValueSet/participation-role-type" }, "mapping": [ { "identity": "workflow", "map": "Event.performer.function" }, { "identity": "rim", "map": ".role" }, { "identity": "fhirauditevent", "map": "AuditEvent.agent.type" }, { "identity": "w3c.prov", "map": "Agent.Attribution" } ] }, { "id": "Provenance.agent.role", "path": "Provenance.agent.role", "short": "What the agents role was", "definition": "The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.", "comment": "For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.", "requirements": "Structural roles reflect the structural aspects of relationships between entities. Structural roles describe prerequisites, feasibilities, or competences for acts. Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models..", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProvenanceAgentRole" } ], "strength": "example", "description": "The role that a provenance agent played with respect to the activity.", "valueSet": "http://hl7.org/fhir/ValueSet/security-role-type" }, "mapping": [ { "identity": "rim", "map": ".typecode" }, { "identity": "fhirauditevent", "map": "AuditEvent.agent.role" } ] }, { "id": "Provenance.agent.who", "path": "Provenance.agent.who", "short": "The agent that participated in the event", "definition": "Indicates who or what performed in the event.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "rim", "map": ".id" } ] }, { "id": "Provenance.agent.onBehalfOf", "path": "Provenance.agent.onBehalfOf", "short": "The agent that delegated", "definition": "The agent that delegated authority to perform the activity performed by the agent.who element.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] } ], "mapping": [ { "identity": "rim", "map": "Person, Practitioner, Organization, Device :* .role [classCode = RoleClassMutualRelationship; role.code and * .scopes[Role](classCode=IDENT) and *.plays [Role.Code]" } ] }, { "id": "Provenance.entity", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" }, { "url": "http://hl7.org/fhir/build/StructureDefinition/svg", "valueCode": "440,30" } ], "path": "Provenance.entity", "short": "An entity used in this activity", "definition": "An entity used in this activity.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./subjectOf" }, { "identity": "fhirauditevent", "map": "AuditEvent.entity" }, { "identity": "w3c.prov", "map": "Entity" } ] }, { "id": "Provenance.entity.role", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes", "valueString": "No uses cases have been identified for extensibility for this role." } ], "path": "Provenance.entity.role", "short": "revision | quotation | source | instantiates | removal", "definition": "How the entity was used during the activity.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProvenanceEntityRole" } ], "strength": "required", "description": "How an entity was used in an activity.", "valueSet": "http://hl7.org/fhir/ValueSet/provenance-entity-role" }, "mapping": [ { "identity": "rim", "map": "./typeCode" }, { "identity": "fhirauditevent", "map": "AuditEvent.entity.role" }, { "identity": "w3c.prov", "map": "Entity.role" } ] }, { "id": "Provenance.entity.what", "path": "Provenance.entity.what", "short": "Identity of entity", "definition": "Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.", "comment": "whatIdentity should be used for entities that are not a Resource type.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./text/reference" }, { "identity": "fhirauditevent", "map": "AuditEvent.entity.reference" }, { "identity": "w3c.prov", "map": "Entity.Identity" } ] }, { "id": "Provenance.entity.agent", "path": "Provenance.entity.agent", "short": "Entity is attributed to this agent", "definition": "The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which used the entity.", "comment": "A usecase where one Provenance.entity.agent is used where the Entity that was used in the creation/updating of the Target, is not in the context of the same custodianship as the Target, and thus the meaning of Provenance.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 v2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the Provenance of that Entity's use in the context of this Provenance activity.", "min": 0, "max": "*", "contentReference": "#Provenance.agent", "mapping": [ { "identity": "rim", "map": "./author/role" }, { "identity": "fhirauditevent", "map": "AuditEvent.entity.agent" } ] }, { "id": "Provenance.signature", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "path": "Provenance.signature", "short": "Signature on target", "definition": "A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.", "min": 0, "max": "*", "type": [ { "code": "Signature" } ], "mapping": [ { "identity": "rim", "map": "./signatureText" } ] } ] } }