This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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
(No assigned work group) | Maturity Level: 0 | 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..* | |||
target | S | 1..* | Reference(Resource) | |
period | S | 0..1 | Period | |
recorded | S | 1..1 | instant | |
reason | S | 0..* | Coding | Binding: PurposeOfUse (extensible) |
activity | S | 0..1 | Coding | |
location | S | 0..1 | Reference(Location) | |
policy | S | 0..* | uri | |
agent | S | 1..* | BackboneElement | |
actor | S | |||
userId | S | |||
signature | S | 0..* | Signature | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | I | 0..* | 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: Common Languages (extensible) | |
text | I | 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) |
period | S | 0..1 | Period | When the activity occurred |
recorded | S∑ | 1..1 | instant | When the activity was recorded / updated |
reason | S | 0..* | Coding | Reason the activity is occurring Binding: PurposeOfUse (extensible) |
activity | S | 0..1 | Coding | Activity that occurred Binding: ProvenanceEventCurrentState (extensible) |
location | S | 0..1 | Reference(Location) | Where the activity occurred, if relevant |
policy | S | 0..* | uri | Policy or plan the activity was defined by |
agent | SI | 1..* | BackboneElement | Actor involved |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
role | ∑ | 1..1 | Coding | What the agents involvement was Binding: ProvenanceParticipantRole (extensible) |
who[x] | ∑ | 1..1 | uri, Reference(Practitioner), Reference(RelatedPerson), Reference(Patient), Reference(Device), Reference(Organization) | Who participated |
onBehalfOf[x] | 0..1 | uri, Reference(Practitioner), Reference(RelatedPerson), Reference(Patient), Reference(Device), Reference(Organization) | On behalf of | |
relatedAgentType | 0..1 | CodeableConcept | Type of relationship between agents Binding: v3 Code System RoleLinkType (example) | |
entity | I | 0..* | BackboneElement | An entity used in this activity |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
role | ∑ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required) |
reference | ∑ | 1..1 | Reference(Resource) | Identity of entity |
agent | 0..* | Unknown reference to #Provenance:ehrsrle-provenance.agent Entity is attributed to this agent | ||
signature | S | 0..* | Signature | Signature on target |
Documentation for this format |
todo
This structure is derived from Provenance.
Differential View
This structure is derived from Provenance.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | 0..* | |||
target | S | 1..* | Reference(Resource) | |
period | S | 0..1 | Period | |
recorded | S | 1..1 | instant | |
reason | S | 0..* | Coding | Binding: PurposeOfUse (extensible) |
activity | S | 0..1 | Coding | |
location | S | 0..1 | Reference(Location) | |
policy | S | 0..* | uri | |
agent | S | 1..* | BackboneElement | |
actor | S | |||
userId | S | |||
signature | S | 0..* | Signature | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | I | 0..* | 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: Common Languages (extensible) | |
text | I | 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) |
period | S | 0..1 | Period | When the activity occurred |
recorded | S∑ | 1..1 | instant | When the activity was recorded / updated |
reason | S | 0..* | Coding | Reason the activity is occurring Binding: PurposeOfUse (extensible) |
activity | S | 0..1 | Coding | Activity that occurred Binding: ProvenanceEventCurrentState (extensible) |
location | S | 0..1 | Reference(Location) | Where the activity occurred, if relevant |
policy | S | 0..* | uri | Policy or plan the activity was defined by |
agent | SI | 1..* | BackboneElement | Actor involved |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
role | ∑ | 1..1 | Coding | What the agents involvement was Binding: ProvenanceParticipantRole (extensible) |
who[x] | ∑ | 1..1 | uri, Reference(Practitioner), Reference(RelatedPerson), Reference(Patient), Reference(Device), Reference(Organization) | Who participated |
onBehalfOf[x] | 0..1 | uri, Reference(Practitioner), Reference(RelatedPerson), Reference(Patient), Reference(Device), Reference(Organization) | On behalf of | |
relatedAgentType | 0..1 | CodeableConcept | Type of relationship between agents Binding: v3 Code System RoleLinkType (example) | |
entity | I | 0..* | BackboneElement | An entity used in this activity |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
role | ∑ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required) |
reference | ∑ | 1..1 | Reference(Resource) | Identity of entity |
agent | 0..* | Unknown reference to #Provenance:ehrsrle-provenance.agent Entity is attributed to this agent | ||
signature | S | 0..* | Signature | Signature on target |
Documentation for this format |
XML Template
JSON Template
todo
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
Provenance.language | Common Languages | extensible | Common Languages |
Provenance.reason | PurposeOfUse | extensible | PurposeOfUse |
Provenance.activity | ProvenanceEventCurrentState | extensible | ProvenanceEventCurrentState |
Provenance.agent.role | ProvenanceParticipantRole | extensible | ProvenanceParticipantRole |
Provenance.agent.relatedAgentType | v3 Code System RoleLinkType | example | v3 Code System RoleLinkType |
Provenance.entity.role | ProvenanceEntityRole | required | ProvenanceEntityRole |