FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Security Work GroupMaturity Level: N/ABallot Status: InformativeCompartments: Device, Patient, Practitioner, RelatedPerson

Mappings for the provenance resource.

ProvenanceControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN]
    target./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target OR ./participation[isNormalParticipation() and typeCode=SBJ]/role OR ./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player
    period./effectiveTime[type=IVL_TS]
    recordedunique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS])
    policy./inboundRelationship[isNormalActRelationship() and typeCode="SUBJ"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel
    locationunique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode="LOC" and determinerCode="INST"]
    reasonunique(./reasonCode)
    activityAct.code
    agent./participation[isNormalParticipation()] OR ./outboundRelationship[isNormalActRelationship() and typeCode='DRIV']
        role.role and/or .typecode
        who[x].id
        onBehalfOf[x]Person, Practitioner, Organization, Device :* .role [classCode = RoleClassMutualRelationship; role.code and * .scopes[Role](classCode=IDENT) and *.plays [Role.Code]
        relatedAgentType.typeCode
    entity./subjectOf
        role./typeCode
        what[x]./text/reference
        agent./author/role
    signature./signatureText

The provenance resource is based on known practices in the HL7 implementation space, particularly those found in the v2 EVN segment, the v3 ControlAct Wrapper, the CDA header, and IHE ATNA. The conceptual model underlying the design is the W3C provenance Specification . Though the content and format of the resource is designed to meet specific requirements for FHIR, all the parts of the resource are formally mapped to the PROV-O specification, and FHIR resources can be transformed to their W3C PROV equivalent.

ProvenanceActivity
    targetEntity Created/Updated
    periodActivity.startTime & Activity.endTime
    recordedActivity.when
    policy
    locationActivity.location
    reasonActivity.Activity
    activityActivity.Activity
    agentAgent
        roleAgent.Attribution
        who[x]
        onBehalfOf[x]
        relatedAgentTypetype
    entityEntity
        roleEntity.role
        what[x]Entity.Identity
        agent
    signature
Provenance
    targetAuditEvent.entity.reference
    period
    recordedAuditEvent.recorded
    policyAuditEvent.agent.policy
    locationAuditEvent.agent.location
    reasonAuditEvent.purposeOfEvent
    activityAuditEvent.purposeOfEvent
    agentAuditEvent.agent
        roleAuditEvent.agent.role
        who[x]
        onBehalfOf[x]
        relatedAgentType
    entityAuditEvent.entity
        roleAuditEvent.entity.lifecycle
        what[x]AuditEvent.entity.reference
        agent
    signature