This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). 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: R4 R3 R2
Electronic Health Records Work Group | Maturity Level: 1 | Trial 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+1100 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.
This structure is derived from Provenance.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
target | S | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) |
occurred[x] | S | 0..1 | Period, dateTime | When the activity occurred |
recorded | S | 1..1 | instant | When the activity was recorded / updated |
policy | S | 0..* | uri | Policy or plan the activity was defined by |
location | S | 0..1 | Reference(Location) | Where the activity occurred, if relevant |
reason | S | 0..* | CodeableConcept | Reason the activity is occurring |
activity | S | 0..1 | CodeableConcept | Activity that occurred |
agent | S | 1..* | BackboneElement | Actor involved |
who | S | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
onBehalfOf | S | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing |
signature | S | 0..* | Signature | Signature on target |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | I | 0..* | Provenance | Who, What, When for a set of resources |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) Max Binding: All Languages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
target | SΣI | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) |
occurred[x] | SI | 0..1 | When the activity occurred | |
occurredPeriod | Period | |||
occurredDateTime | dateTime | |||
recorded | SΣI | 1..1 | instant | When the activity was recorded / updated |
policy | SI | 0..* | uri | Policy or plan the activity was defined by |
location | SI | 0..1 | Reference(Location) | Where the activity occurred, if relevant |
reason | SI | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible) |
activity | SI | 0..1 | CodeableConcept | Activity that occurred Binding: Provenance activity type (extensible) |
agent | SI | 1..* | BackboneElement | Actor involved |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | ΣI | 0..1 | CodeableConcept | How the agent participated Binding: Provenance participant type (extensible) |
role | I | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example) |
who | SΣI | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
onBehalfOf | SI | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing |
entity | I | 0..* | BackboneElement | An entity used in this activity |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | ΣI | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required) |
what | ΣI | 1..1 | Reference(Resource) | Identity of entity |
agent | I | 0..* | Unknown reference to #Provenance.agent Entity is attributed to this agent | |
signature | SI | 0..* | Signature | Signature on target |
Documentation for this format |
<!-- EHRS FM Record Lifecycle Event - Provenance --> <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> <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) Who participated --></who> <onBehalfOf><!-- 0..1 Reference(Practitioner) Who the agent is representing --></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 #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 "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.
Differential View
This structure is derived from Provenance.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
target | S | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) |
occurred[x] | S | 0..1 | Period, dateTime | When the activity occurred |
recorded | S | 1..1 | instant | When the activity was recorded / updated |
policy | S | 0..* | uri | Policy or plan the activity was defined by |
location | S | 0..1 | Reference(Location) | Where the activity occurred, if relevant |
reason | S | 0..* | CodeableConcept | Reason the activity is occurring |
activity | S | 0..1 | CodeableConcept | Activity that occurred |
agent | S | 1..* | BackboneElement | Actor involved |
who | S | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
onBehalfOf | S | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing |
signature | S | 0..* | Signature | Signature on target |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | I | 0..* | Provenance | Who, What, When for a set of resources |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) Max Binding: All Languages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
target | SΣI | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) |
occurred[x] | SI | 0..1 | When the activity occurred | |
occurredPeriod | Period | |||
occurredDateTime | dateTime | |||
recorded | SΣI | 1..1 | instant | When the activity was recorded / updated |
policy | SI | 0..* | uri | Policy or plan the activity was defined by |
location | SI | 0..1 | Reference(Location) | Where the activity occurred, if relevant |
reason | SI | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible) |
activity | SI | 0..1 | CodeableConcept | Activity that occurred Binding: Provenance activity type (extensible) |
agent | SI | 1..* | BackboneElement | Actor involved |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | ΣI | 0..1 | CodeableConcept | How the agent participated Binding: Provenance participant type (extensible) |
role | I | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example) |
who | SΣI | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
onBehalfOf | SI | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing |
entity | I | 0..* | BackboneElement | An entity used in this activity |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | ΣI | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required) |
what | ΣI | 1..1 | Reference(Resource) | Identity of entity |
agent | I | 0..* | Unknown reference to #Provenance.agent Entity is attributed to this agent | |
signature | SI | 0..* | Signature | Signature on target |
Documentation for this format |
XML Template
<!-- EHRS FM Record Lifecycle Event - Provenance --> <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> <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) Who participated --></who> <onBehalfOf><!-- 0..1 Reference(Practitioner) Who the agent is representing --></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 #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 "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
Path | Name | Conformance | ValueSet |
Provenance.language | Common Languages | preferred | Common Languages |
Provenance.reason | V3 Value SetPurposeOfUse | extensible | V3 Value SetPurposeOfUse |
Provenance.activity | Provenance activity type | extensible | Provenance activity type |
Provenance.agent.type | Provenance participant type | extensible | Provenance participant type |
Provenance.agent.role | SecurityRoleType | example | SecurityRoleType |
Provenance.entity.role | ProvenanceEntityRole | required | ProvenanceEntityRole |