EHR and PHR System Functional Models - Record Lifecycle Events Implementation Guide
1.1.0-ballot - Informative Release 1
EHR and PHR System Functional Models - Record Lifecycle Events Implementation Guide
1.1.0-ballot - Informative Release 1
This page is part of the EHRS Functional Model - Record Lifecycle Events Implementation Guide (v1.1.0-ballot: Informative Release 1 Ballot 2) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/uv/ehrs-rle/StructureDefinition/ehrsrle-provenance | Version: 1.1.0-ballot | |||
| Standards status: Informative | Maturity Level: 1 | Computable Name: EHRSFunctionalModelRecordLifecycleEventsProvenance | ||
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
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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 | 0..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 |
| activity | S | 0..1 | CodeableConcept | Activity that occurred |
 agent | S | 1..* | BackboneElement | Actor involved |
 who | S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The agent that participated in the event |
 onBehalfOf | S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient) | The agent that delegated |
| signature | S | 0..* | Signature | Signature on target |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
 target | SΣ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) |
 occurred[x] | S | 0..1 | When the activity occurred | |
 occurredPeriod | Period | |||
| occurredDateTime | dateTime | |||
| recorded | SΣ | 0..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 |
| activity | S | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (example): The activity that took place. |
| agent | SΣC | 1..* | BackboneElement | Actor involved |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| who | SΣC | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The agent that participated in the event |
| onBehalfOf | SC | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient) | The agent that delegated |
| signature | S | 0..* | Signature | Signature on target |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Provenance.activity | example | ProvenanceActivityType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Provenance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prov-1 | error | Provenance.agent | Who and onBehalfOf cannot be the same : who.resolve().exists() and onBehalfOf.resolve().exists() implies who.resolve() != onBehalfOf.resolve() | |
| prov-2 | error | Provenance.agent | If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner : who.resolve().ofType(PractitionerRole).practitioner.resolve().exists() and onBehalfOf.resolve().ofType(Practitioner).exists() implies who.resolve().practitioner.resolve() != onBehalfOf.resolve() | |
| prov-3 | error | Provenance.agent | If who is an organization, onBehalfOf can't be a PractitionerRole within that organization : who.resolve().ofType(Organization).exists() and onBehalfOf.resolve().ofType(PractitionerRole).organization.resolve().exists() implies who.resolve() != onBehalfOf.resolve().organization.resolve() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| target | SΣ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) |
| occurred[x] | S | 0..1 | When the activity occurred | |
| occurredPeriod | Period | |||
| occurredDateTime | dateTime | |||
| recorded | SΣ | 0..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 |
| authorization | 0..* | CodeableReference() | Authorization (purposeOfUse) related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. | |
| activity | S | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (example): The activity that took place. |
| basedOn | TU | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) | Workflow authorization within which this event occurred |
| patient | TU | 0..1 | Reference(Patient) | The patient is the subject of the data created/updated (.target) by the activity |
| encounter | TU | 0..1 | Reference(Encounter) | Encounter within which this event occurred or which the event is tightly associated |
| agent | SΣC | 1..* | BackboneElement | Actor involved |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 0..1 | CodeableConcept | How the agent participated Binding: ParticipationRoleType (example): The type of participation that a provenance agent played with respect to the activity. |
| role | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
| who | SΣC | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The agent that participated in the event |
| onBehalfOf | SC | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient) | The agent that delegated |
| entity | ΣTU | 0..* | BackboneElement | An entity used in this activity |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | Σ | 1..1 | code | revision | quotation | source | instantiates | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. |
| what | Σ | 1..1 | Reference(Resource) | Identity of entity |
| agent | 0..* | See agent (Provenance) | Entity is attributed to this agent | |
| signature | S | 0..* | Signature | Signature on target |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Provenance.language | required | AllLanguages |
| Provenance.authorization | example | PurposeOfUse |
| Provenance.activity | example | ProvenanceActivityType |
| Provenance.agent.type | example | ParticipationRoleType |
| Provenance.agent.role | example | SecurityRoleType |
| Provenance.entity.role | required | ProvenanceEntityRole |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prov-1 | error | Provenance.agent | Who and onBehalfOf cannot be the same : who.resolve().exists() and onBehalfOf.resolve().exists() implies who.resolve() != onBehalfOf.resolve() | |
| prov-2 | error | Provenance.agent | If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner : who.resolve().ofType(PractitionerRole).practitioner.resolve().exists() and onBehalfOf.resolve().ofType(Practitioner).exists() implies who.resolve().practitioner.resolve() != onBehalfOf.resolve() | |
| prov-3 | error | Provenance.agent | If who is an organization, onBehalfOf can't be a PractitionerRole within that organization : who.resolve().ofType(Organization).exists() and onBehalfOf.resolve().ofType(PractitionerRole).organization.resolve().exists() implies who.resolve() != onBehalfOf.resolve().organization.resolve() |
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 | 0..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 |
| activity | S | 0..1 | CodeableConcept | Activity that occurred |
| agent | S | 1..* | BackboneElement | Actor involved |
| who | S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The agent that participated in the event |
| onBehalfOf | S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient) | The agent that delegated |
| signature | S | 0..* | Signature | Signature on target |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| target | SΣ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) |
| occurred[x] | S | 0..1 | When the activity occurred | |
| occurredPeriod | Period | |||
| occurredDateTime | dateTime | |||
| recorded | SΣ | 0..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 |
| activity | S | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (example): The activity that took place. |
| agent | SΣC | 1..* | BackboneElement | Actor involved |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| who | SΣC | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The agent that participated in the event |
| onBehalfOf | SC | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient) | The agent that delegated |
| signature | S | 0..* | Signature | Signature on target |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Provenance.activity | example | ProvenanceActivityType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Provenance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prov-1 | error | Provenance.agent | Who and onBehalfOf cannot be the same : who.resolve().exists() and onBehalfOf.resolve().exists() implies who.resolve() != onBehalfOf.resolve() | |
| prov-2 | error | Provenance.agent | If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner : who.resolve().ofType(PractitionerRole).practitioner.resolve().exists() and onBehalfOf.resolve().ofType(Practitioner).exists() implies who.resolve().practitioner.resolve() != onBehalfOf.resolve() | |
| prov-3 | error | Provenance.agent | If who is an organization, onBehalfOf can't be a PractitionerRole within that organization : who.resolve().ofType(Organization).exists() and onBehalfOf.resolve().ofType(PractitionerRole).organization.resolve().exists() implies who.resolve() != onBehalfOf.resolve().organization.resolve() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| target | SΣ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) |
| occurred[x] | S | 0..1 | When the activity occurred | |
| occurredPeriod | Period | |||
| occurredDateTime | dateTime | |||
| recorded | SΣ | 0..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 |
| authorization | 0..* | CodeableReference() | Authorization (purposeOfUse) related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. | |
| activity | S | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (example): The activity that took place. |
| basedOn | TU | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) | Workflow authorization within which this event occurred |
| patient | TU | 0..1 | Reference(Patient) | The patient is the subject of the data created/updated (.target) by the activity |
| encounter | TU | 0..1 | Reference(Encounter) | Encounter within which this event occurred or which the event is tightly associated |
| agent | SΣC | 1..* | BackboneElement | Actor involved |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 0..1 | CodeableConcept | How the agent participated Binding: ParticipationRoleType (example): The type of participation that a provenance agent played with respect to the activity. |
| role | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
| who | SΣC | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The agent that participated in the event |
| onBehalfOf | SC | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient) | The agent that delegated |
| entity | ΣTU | 0..* | BackboneElement | An entity used in this activity |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | Σ | 1..1 | code | revision | quotation | source | instantiates | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. |
| what | Σ | 1..1 | Reference(Resource) | Identity of entity |
| agent | 0..* | See agent (Provenance) | Entity is attributed to this agent | |
| signature | S | 0..* | Signature | Signature on target |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Provenance.language | required | AllLanguages |
| Provenance.authorization | example | PurposeOfUse |
| Provenance.activity | example | ProvenanceActivityType |
| Provenance.agent.type | example | ParticipationRoleType |
| Provenance.agent.role | example | SecurityRoleType |
| Provenance.entity.role | required | ProvenanceEntityRole |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prov-1 | error | Provenance.agent | Who and onBehalfOf cannot be the same : who.resolve().exists() and onBehalfOf.resolve().exists() implies who.resolve() != onBehalfOf.resolve() | |
| prov-2 | error | Provenance.agent | If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner : who.resolve().ofType(PractitionerRole).practitioner.resolve().exists() and onBehalfOf.resolve().ofType(Practitioner).exists() implies who.resolve().practitioner.resolve() != onBehalfOf.resolve() | |
| prov-3 | error | Provenance.agent | If who is an organization, onBehalfOf can't be a PractitionerRole within that organization : who.resolve().ofType(Organization).exists() and onBehalfOf.resolve().ofType(PractitionerRole).organization.resolve().exists() implies who.resolve() != onBehalfOf.resolve().organization.resolve() |
This structure is derived from Provenance
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ Health Level Seven International - Electronic Health Record Work Group. Package hl7.fhir.uv.ehrs-rle#1.1.0-ballot based on FHIR 5.0.0. Generated 2023-03-29
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change