abstractbaseDefinitioncopyrightdescriptionexperimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisherpurposestatustitletypeurl| Left: | US Core Provenance Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance) |
| Right: | US Core Provenance Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance) |
| Name | Value | Comments | |
|---|---|---|---|
| abstract | false | ||
| baseDefinition | http://hl7.org/fhir/StructureDefinition/Provenance | ||
| copyright | Used by permission of HL7 International, all rights reserved Creative Commons License | ||
| description | The US Core Provenance Profile inherits from the FHIR [Provenance](https://hl7.org/fhir/R4/provenance.html) resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Provenance resource to record, search, and fetch provenance information associated with a record. It covers the minimal (basic) information to support lineage of information. It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains how the elements are used. Before reviewing this profile, implementers are encouraged to read the Basic Provenance guidance page, which documents several key use cases, specifically, the organization responsible for the most recent action on the resource. | ||
| experimental | |||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
| jurisdiction[0] | urn:iso:std:iso:3166#US | ||
| kind | resource | ||
| name | USCoreProvenance | ||
| publisher | HL7 International / Cross-Group Projects | ||
| purpose | |||
| status | active | ||
| title | US Core Provenance Profile | ||
| type | Provenance | ||
| url | http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance | ||
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 Provenance | 0..* | Provenance | US Core Provenance | 0..* | Provenance | US Core Provenance | |||||||||||
 id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
| language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
| contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
 extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
| target | SΣ | 1..* | Reference(Resource) | The Resource this Provenance record supports | SΣ | 1..* | Reference(Resource) | The Resource this Provenance record supports | |||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| reference | SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | |||||||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||
| display | Σ | 0..1 | string | Text alternative for the resource | Σ | 0..1 | string | Text alternative for the resource | |||||||||
| occurred[x] | 0..1 | Period, dateTime | When the activity occurred | 0..1 | Period, dateTime | When the activity occurred | |||||||||||
| recorded | SΣ | 1..1 | instant | Timestamp when the activity was recorded / updated | SΣ | 1..1 | instant | Timestamp when the activity was recorded / updated | |||||||||
| policy | 0..* | uri | Policy or plan the activity was defined by | 0..* | uri | Policy or plan the activity was defined by | |||||||||||
| location | 0..1 | Reference(Location) | Where the activity occurred, if relevant | 0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||||||||
| reason | 0..* | CodeableConcept | Reason the activity is occurring Binding: ?? (extensible): The reason the activity took place. | 0..* | CodeableConcept | Reason the activity is occurring Binding: ?? (extensible): The reason the activity took place. | |||||||||||
| activity | 0..1 | CodeableConcept | Activity that occurred Binding: ?? (extensible): The activity that took place. | 0..1 | CodeableConcept | Activity that occurred Binding: ?? (extensible): The activity that took place. | |||||||||||
| Slices for agent | SC | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device | SC | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| type | SΣ | 0..1 | CodeableConcept | How the agent participated Binding: ?? (extensible) | SΣ | 0..1 | CodeableConcept | How the agent participated Binding: ?? (extensible) | |||||||||
| role | 0..* | CodeableConcept | What the agents role was Binding: ?? (example): The role that a provenance agent played with respect to the activity. | 0..* | CodeableConcept | What the agents role was Binding: ?? (example): The role that a provenance agent played with respect to the activity. | |||||||||||
| who | SΣ | 1..1 | Reference(US Core Organization Profile S | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | Who participated | SΣ | 1..1 | Reference(US Core Organization Profile S | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | Who participated | |||||||||
| onBehalfOf | S | 0..1 | Reference(US Core Organization Profile) | Who the agent is representing | S | 0..1 | Reference(US Core Organization Profile) | Who the agent is representing | |||||||||
| entity | 0..* | BackboneElement | An entity used in this activity | 0..* | BackboneElement | An entity used in this activity | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ?? (required): How an entity was used in an activity. | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ?? (required): How an entity was used in an activity. | |||||||||
| what | Σ | 1..1 | Reference(Resource) | Identity of entity | Σ | 1..1 | Reference(Resource) | Identity of entity | |||||||||
 agent | 0..* | See agent (Provenance) | Entity is attributed to this agent | 0..* | See agent (Provenance) | Entity is attributed to this agent | |||||||||||
| signature | 0..* | Signature | Signature on target | 0..* | Signature | Signature on target | |||||||||||
| Documentation for this format | |||||||||||||||||