Release 5 Draft Ballot
Electronic Health Records Work Group Maturity Level: 1Trial Use Use Context: Any

The official URL for this profile is:

http://hl7.org/fhir/StructureDefinition/ehrsrle-provenance

Defines the elements to be supported within the Provenance resource in order to conform with the Electronic Health Record System Functional Model Record Lifecycle Event standard

This profile was published on Fri, Jan 31, 2014 00:00+0000 as a draft by Health Level Seven International (Electronic Health Record).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Provenance.

Summary

Must-Support: 11 elements

This structure is derived from Provenance.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... target S1..*Reference(Resource)Target Reference(s) (usually version specific)
... occurred[x] S0..1Period, dateTimeWhen the activity occurred
... recorded S1..1instantWhen the activity was recorded / updated
... location S0..1Reference(Location)Where the activity occurred, if relevant
... reason S0..*CodeableConceptReason the activity is occurring
... activity S0..1CodeableConceptActivity that occurred
... agent S1..*BackboneElementActor involved
.... who S1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)The agent that participated in the event
.... onBehalfOf S0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)The agent that delegated
... signature S0..*SignatureSignature on target

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target SΣ1..*Reference(Resource)Target Reference(s) (usually version specific)
... occurred[x] S0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded SΣ1..1instantWhen the activity was recorded / updated
... policy S0..*uriPolicy or plan the activity was defined by
... location S0..1Reference(Location)Where the activity occurred, if relevant
... reason S0..*CodeableConceptReason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


... activity S0..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... basedOn 0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Workflow authorization within which this event occurred
... encounter 0..1Reference(Encounter)Encounter within which this event occurred or which the event is tightly associated
... agent S1..*BackboneElementActor involved
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptHow the agent participated
Binding: ParticipationRoleType (extensible): The type of participation that a provenance agent played with respect to the activity.

.... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


.... who SΣ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)The agent that participated in the event
.... onBehalfOf S0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)The agent that delegated
... entity 0..*BackboneElementAn entity used in this activity
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.

.... what Σ1..1Reference(Resource)Identity of entity
.... agent 0..*See agent (Provenance)Entity is attributed to this agent
... signature S0..*SignatureSignature on target

doco Documentation for this format
<!-- EHRS FM Record Lifecycle Event - Provenance -->doco

<Provenance xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <target><!-- ?? 1..* Reference(Resource) 
     Target Reference(s) (usually version specific) --></target>
 <occurred[x]><!-- ?? 0..1 Period|dateTime 
     When the activity occurred --></occurred[x]>
 <recorded value="[instant]"/><!-- ?? 1..1 When the activity was recorded / updated -->
 <policy value="[uri]"/><!-- ?? 0..* Policy or plan the activity was defined by -->
 <location><!-- ?? 0..1 Reference(Location) 
     Where the activity occurred, if relevant --></location>
 <reason><!-- ?? 0..* CodeableConcept Reason the activity is occurring    --></reason>
 <activity><!-- ?? 0..1 CodeableConcept Activity that occurred   --></activity>
 <basedOn><!-- ?? 0..* Reference(CarePlan) 
     Workflow authorization within which this event occurred --></basedOn>
 <encounter><!-- ?? 0..1 Reference(Encounter) 
     Encounter within which this event occurred or which the event is tightly associated --></encounter>
 <agent> ?? 1..* BackboneElement  <!-- ?? 1..* Actor involved -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <type><!-- ?? 0..1 CodeableConcept How the agent participated   --></type>
  <role><!-- ?? 0..* CodeableConcept What the agents role was   --></role>
  <who><!-- ?? 1..1 Reference(Practitioner) 
      The agent that participated in the event --></who>
  <onBehalfOf><!-- ?? 0..1 Reference(Practitioner) 
      The agent that delegated --></onBehalfOf>
 </agent>
 <entity> ?? 0..* BackboneElement  <!-- ?? 0..* An entity used in this activity -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <role value="[code]"/><!-- ?? 1..1 derivation | revision | quotation | source | removal   -->
  <what><!-- ?? 1..1 Reference(Resource) Identity of entity --></what>
  <agent><!-- See http://hl7.org/fhir/StructureDefinition/Provenance#Provenance.agent  Entity is attributed to this agent --></agent>
 </entity>
 <signature><!-- ?? 0..* Signature Signature on target --></signature>
</Provenance>
{ // EHRS FM Record Lifecycle Event - Provenance
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "target" : [{ Reference(Resource) }], // C? R! Target Reference(s) (usually version specific)
// value[x]: When the activity occurred. One of these 2:
    "occurredPeriod" : { Period }, // C?When the activity occurred
    "occurredDateTime" : "<dateTime>", // C?When the activity occurred
    "recorded" : "<instant>", // C? R! When the activity was recorded / updated
    "policy" : ["<uri>"], // C?Policy or plan the activity was defined by
    "location" : { Reference(Location) }, // C?Where the activity occurred, if relevant
    "reason" : [{ CodeableConcept }], // C?Reason the activity is occurring 
    "activity" : { CodeableConcept }, // C?Activity that occurred
    "basedOn" : [{ Reference(CarePlan) }], // C?Workflow authorization within which this event occurred
    "encounter" : { Reference(Encounter) }, // C?Encounter within which this event occurred or which the event is tightly associated
    "agent" : [{ BackboneElement }], // C? R! Actor involved
    "entity" : [{ BackboneElement }] // C?An entity used in this activity
    "signature" : [{ Signature }], // C?Signature on target
  }

This structure is derived from Provenance.

Summary

Must-Support: 11 elements

Differential View

This structure is derived from Provenance.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... target S1..*Reference(Resource)Target Reference(s) (usually version specific)
... occurred[x] S0..1Period, dateTimeWhen the activity occurred
... recorded S1..1instantWhen the activity was recorded / updated
... location S0..1Reference(Location)Where the activity occurred, if relevant
... reason S0..*CodeableConceptReason the activity is occurring
... activity S0..1CodeableConceptActivity that occurred
... agent S1..*BackboneElementActor involved
.... who S1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)The agent that participated in the event
.... onBehalfOf S0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)The agent that delegated
... signature S0..*SignatureSignature on target

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target SΣ1..*Reference(Resource)Target Reference(s) (usually version specific)
... occurred[x] S0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded SΣ1..1instantWhen the activity was recorded / updated
... policy S0..*uriPolicy or plan the activity was defined by
... location S0..1Reference(Location)Where the activity occurred, if relevant
... reason S0..*CodeableConceptReason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


... activity S0..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... basedOn 0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Workflow authorization within which this event occurred
... encounter 0..1Reference(Encounter)Encounter within which this event occurred or which the event is tightly associated
... agent S1..*BackboneElementActor involved
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptHow the agent participated
Binding: ParticipationRoleType (extensible): The type of participation that a provenance agent played with respect to the activity.

.... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


.... who SΣ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)The agent that participated in the event
.... onBehalfOf S0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)The agent that delegated
... entity 0..*BackboneElementAn entity used in this activity
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.

.... what Σ1..1Reference(Resource)Identity of entity
.... agent 0..*See agent (Provenance)Entity is attributed to this agent
... signature S0..*SignatureSignature on target

doco Documentation for this format

XML Template

<!-- EHRS FM Record Lifecycle Event - Provenance -->doco

<Provenance xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <target><!-- ?? 1..* Reference(Resource) 
     Target Reference(s) (usually version specific) --></target>
 <occurred[x]><!-- ?? 0..1 Period|dateTime 
     When the activity occurred --></occurred[x]>
 <recorded value="[instant]"/><!-- ?? 1..1 When the activity was recorded / updated -->
 <policy value="[uri]"/><!-- ?? 0..* Policy or plan the activity was defined by -->
 <location><!-- ?? 0..1 Reference(Location) 
     Where the activity occurred, if relevant --></location>
 <reason><!-- ?? 0..* CodeableConcept Reason the activity is occurring    --></reason>
 <activity><!-- ?? 0..1 CodeableConcept Activity that occurred   --></activity>
 <basedOn><!-- ?? 0..* Reference(CarePlan) 
     Workflow authorization within which this event occurred --></basedOn>
 <encounter><!-- ?? 0..1 Reference(Encounter) 
     Encounter within which this event occurred or which the event is tightly associated --></encounter>
 <agent> ?? 1..* BackboneElement  <!-- ?? 1..* Actor involved -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <type><!-- ?? 0..1 CodeableConcept How the agent participated   --></type>
  <role><!-- ?? 0..* CodeableConcept What the agents role was   --></role>
  <who><!-- ?? 1..1 Reference(Practitioner) 
      The agent that participated in the event --></who>
  <onBehalfOf><!-- ?? 0..1 Reference(Practitioner) 
      The agent that delegated --></onBehalfOf>
 </agent>
 <entity> ?? 0..* BackboneElement  <!-- ?? 0..* An entity used in this activity -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <role value="[code]"/><!-- ?? 1..1 derivation | revision | quotation | source | removal   -->
  <what><!-- ?? 1..1 Reference(Resource) Identity of entity --></what>
  <agent><!-- See http://hl7.org/fhir/StructureDefinition/Provenance#Provenance.agent  Entity is attributed to this agent --></agent>
 </entity>
 <signature><!-- ?? 0..* Signature Signature on target --></signature>
</Provenance>

JSON Template

{ // EHRS FM Record Lifecycle Event - Provenance
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "target" : [{ Reference(Resource) }], // C? R! Target Reference(s) (usually version specific)
// value[x]: When the activity occurred. One of these 2:
    "occurredPeriod" : { Period }, // C?When the activity occurred
    "occurredDateTime" : "<dateTime>", // C?When the activity occurred
    "recorded" : "<instant>", // C? R! When the activity was recorded / updated
    "policy" : ["<uri>"], // C?Policy or plan the activity was defined by
    "location" : { Reference(Location) }, // C?Where the activity occurred, if relevant
    "reason" : [{ CodeableConcept }], // C?Reason the activity is occurring 
    "activity" : { CodeableConcept }, // C?Activity that occurred
    "basedOn" : [{ Reference(CarePlan) }], // C?Workflow authorization within which this event occurred
    "encounter" : { Reference(Encounter) }, // C?Encounter within which this event occurred or which the event is tightly associated
    "agent" : [{ BackboneElement }], // C? R! Actor involved
    "entity" : [{ BackboneElement }] // C?An entity used in this activity
    "signature" : [{ Signature }], // C?Signature on target
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

PathNameConformanceValueSet
Provenance.languageCommon LanguagespreferredCommon Languages
Provenance.reasonPurposeOfUseextensiblePurposeOfUse
Provenance.activityProvenanceActivityTypeextensibleProvenanceActivityType
Provenance.agent.typeParticipationRoleTypeextensibleParticipationRoleType
Provenance.agent.roleSecurityRoleTypeexampleSecurityRoleType
Provenance.entity.roleProvenanceEntityRolerequiredProvenanceEntityRole
.