PACIO Advance Directive Interoperability Implementation Guide, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-pacio-adi/ and changes regularly. See the Directory of published versions
Active as of 2024-12-06 |
Definitions for the ADI-Provenance resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Provenance | |
2. Provenance.agent:assembler | |
Slice Name | assembler |
Short | Indicates the name of the system used to assemble the person's original advance care planning information into a document for exchange. |
Control | 0..1 |
Must Support | true |
4. Provenance.agent:assembler.type | |
Control | 1..? |
Pattern Value | { |
Guidance on how to interpret the contents of this table can be found here
0. Provenance | |
Definition | - Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies. |
Short | US Core ProvenanceWho, What, When for a set of resources |
Comments | - Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance. |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | History, Event, Activity, Basic Provenance |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) |
2. Provenance.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. Provenance.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Summary | false |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
6. Provenance.target | |
Definition | The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity. |
Short | (USCDI) The Resource this Provenance record supportsTarget Reference(s) (usually version specific) |
Comments | Target references are usually version specific, but might not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource might not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion. |
Control | 1..* |
Type | Reference(Resource) |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
8. Provenance.target.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Short | (USCDI) Literal reference, Relative, internal or absolute URLLiteral reference, Relative, internal or absolute URL |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
10. Provenance.recorded | |
Definition | The instant of time at which the activity was recorded. |
Short | (USCDI) Timestamp when the activity was recorded / updatedWhen the activity was recorded / updated |
Comments | This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource. |
Control | 1..1 |
Type | instant |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
12. Provenance.agent | |
Definition | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. |
Short | (USCDI) Actor involvedActor involved |
Comments | Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. |
Control | 1..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device ( who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists() ) |
Slicing | This element introduces a set of slices on Provenance.agent . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
14. Provenance.agent.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
16. Provenance.agent.type | |
Definition | The participation the agent had with respect to the activity. |
Short | (USCDI) How the agent participatedHow the agent participated |
Comments | For example: author, performer, enterer, attester, etc. |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from US Core Provenance Participant Type Codeshttp://hl7.org/fhir/ValueSet/provenance-agent-type (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. Provenance.agent.who | |
Definition | The individual, device or organization that participated in the event. |
Short | (USCDI) Who participatedWho participated |
Comments | whoIdentity should be used when the agent is not a Resource type. |
Control | 1..1 |
Type | Reference(US Core Organization Profile, US Core Practitioner Profile, US Core Patient Profile, US Core PractitionerRole Profile, US Core RelatedPerson Profile, Device, Practitioner, PractitionerRole, RelatedPerson, Patient, Organization) |
Is Modifier | false |
Must Support | true |
Must Support Types | Reference(US Core Organization Profile) |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. Provenance.agent.onBehalfOf | |
Definition | The individual, device, or organization for whom the change was made. |
Short | (USCDI) Who the agent is representingWho the agent is representing |
Comments | onBehalfOfIdentity should be used when the agent is not a Resource type. |
Control | 0..1 |
Type | Reference(US Core Organization Profile, Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization) |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. Provenance.agent:ProvenanceAuthor | |
Slice Name | ProvenanceAuthor |
Definition | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. |
Short | (USCDI) Actor involvedActor involved |
Comments | Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. |
Control | 01..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. Provenance.agent:ProvenanceAuthor.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
26. Provenance.agent:ProvenanceAuthor.type | |
Definition | The participation the agent had with respect to the activity. |
Short | (USCDI) How the agent participatedHow the agent participated |
Comments | For example: author, performer, enterer, attester, etc. |
Control | 10..1 |
Binding | Unless not suitable, these codes SHALL be taken from ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-type (extensible to http://hl7.org/fhir/ValueSet/provenance-agent-type )The type of participation that a provenance agent played with respect to the activity. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. Provenance.agent:ProvenanceAuthor.who | |
Definition | The individual, device or organization that participated in the event. |
Short | Who participated |
Comments | whoIdentity should be used when the agent is not a Resource type. |
Control | 1..1 |
Type | Reference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
30. Provenance.agent:ProvenanceTransmitter | |
Slice Name | ProvenanceTransmitter |
Definition | The entity that provided the copy to your system. An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. |
Short | (USCDI) Actor involvedActor involved |
Comments | Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. |
Control | 01..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
32. Provenance.agent:ProvenanceTransmitter.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
34. Provenance.agent:ProvenanceTransmitter.type | |
Definition | The participation the agent had with respect to the activity. |
Short | (USCDI) How the agent participatedHow the agent participated |
Comments | For example: author, performer, enterer, attester, etc. |
Control | 10..1 |
Binding | Unless not suitable, these codes SHALL be taken from ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-type (extensible to http://hl7.org/fhir/ValueSet/provenance-agent-type )The type of participation that a provenance agent played with respect to the activity. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. Provenance.agent:ProvenanceTransmitter.who | |
Definition | The individual, device or organization that participated in the event. |
Short | Who participated |
Comments | whoIdentity should be used when the agent is not a Resource type. |
Control | 1..1 |
Type | Reference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. Provenance.agent:assembler | |
Slice Name | assembler |
Definition | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. |
Short | Indicates the name of the system used to assemble the person's original advance care planning information into a document for exchange.Actor involved |
Comments | Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. |
Control | 01..1* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device ( who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists() ) |
40. Provenance.agent:assembler.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
42. Provenance.agent:assembler.type | |
Definition | The participation the agent had with respect to the activity. |
Short | (USCDI) How the agent participatedHow the agent participated |
Comments | For example: author, performer, enterer, attester, etc. |
Control | 10..1 |
Binding | Unless not suitable, these codes SHALL be taken from US Core Provenance Participant Type Codeshttp://hl7.org/fhir/ValueSet/provenance-agent-type (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
44. Provenance.agent:assembler.who | |
Definition | The individual, device or organization that participated in the event. |
Short | (USCDI) Who participatedWho participated |
Comments | whoIdentity should be used when the agent is not a Resource type. |
Control | 1..1 |
Type | Reference(US Core Organization Profile, US Core Practitioner Profile, US Core Patient Profile, US Core PractitionerRole Profile, US Core RelatedPerson Profile, Device, Practitioner, PractitionerRole, RelatedPerson, Patient, Organization) |
Is Modifier | false |
Must Support | true |
Must Support Types | Reference(US Core Organization Profile) |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
46. Provenance.agent:assembler.onBehalfOf | |
Definition | The individual, device, or organization for whom the change was made. |
Short | (USCDI) Who the agent is representingWho the agent is representing |
Comments | onBehalfOfIdentity should be used when the agent is not a Resource type. |
Control | 0..1 |
Type | Reference(US Core Organization Profile, Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization) |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. Provenance | |||||
Definition | - | ||||
Short | US Core Provenance | ||||
Comments | - | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
Alternate Names | History, Event, Activity, Basic Provenance | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-3: 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() )dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() ) | ||||
2. Provenance.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Summary | true | ||||
4. Provenance.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
6. Provenance.implicitRules | |||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
Short | A set of rules under which this content was created | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
8. Provenance.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
10. Provenance.text | |||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Short | Text summary of the resource, for human interpretation | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
12. Provenance.contained | |||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
Short | Contained, inline Resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. Provenance.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
16. Provenance.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
Summary | false | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
18. Provenance.target | |||||
Definition | The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity. | ||||
Short | (USCDI) The Resource this Provenance record supports | ||||
Comments | Target references are usually version specific, but might not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource might not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion. | ||||
Control | 1..* | ||||
Type | Reference(Resource) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
20. Provenance.target.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
22. Provenance.target.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Provenance.target.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
24. Provenance.target.reference | |||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
Short | (USCDI) Literal reference, Relative, internal or absolute URL | ||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
26. Provenance.target.type | |||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||
Short | Type the reference refers to (e.g. "Patient") | ||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types )Aa resource (or, for logical models, the URI of the logical model). | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
28. Provenance.target.identifier | |||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Short | Logical reference, when literal reference is not known | ||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
30. Provenance.target.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Short | Text alternative for the resource | ||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
32. Provenance.occurred[x] | |||||
Definition | The period during which the activity occurred. | ||||
Short | When the activity occurred | ||||
Comments | The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time. | ||||
Control | 0..1 | ||||
Type | Choice of: Period, dateTime | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
34. Provenance.recorded | |||||
Definition | The instant of time at which the activity was recorded. | ||||
Short | (USCDI) Timestamp when the activity was recorded / updated | ||||
Comments | This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource. | ||||
Control | 1..1 | ||||
Type | instant | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
36. Provenance.policy | |||||
Definition | Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc. | ||||
Short | Policy or plan the activity was defined by | ||||
Comments | For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element. | ||||
Control | 0..* | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
38. Provenance.location | |||||
Definition | Where the activity occurred, if relevant. | ||||
Short | Where the activity occurred, if relevant | ||||
Control | 0..1 | ||||
Type | Reference(Location) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
40. Provenance.reason | |||||
Definition | The reason that the activity was taking place. | ||||
Short | Reason the activity is occurring | ||||
Control | 0..* | ||||
Binding | Unless not suitable, these codes SHALL be taken from PurposeOfUse (extensible to http://terminology.hl7.org/ValueSet/v3-PurposeOfUse )The reason the activity took place. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
42. Provenance.activity | |||||
Definition | An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities. | ||||
Short | Activity that occurred | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ProvenanceActivityType (extensible to http://hl7.org/fhir/ValueSet/provenance-activity-type )The activity that took place. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
44. Provenance.agent | |||||
Definition | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. | ||||
Short | (USCDI) Actor involved | ||||
Comments | Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device ( who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists() ) | ||||
Slicing | This element introduces a set of slices on Provenance.agent . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
46. Provenance.agent.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
48. Provenance.agent.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
50. Provenance.agent.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
52. Provenance.agent.type | |||||
Definition | The participation the agent had with respect to the activity. | ||||
Short | (USCDI) How the agent participated | ||||
Comments | For example: author, performer, enterer, attester, etc. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from US Core Provenance Participant Type Codes (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type ) | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
54. Provenance.agent.role | |||||
Definition | The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity. | ||||
Short | What the agents role was | ||||
Comments | For example: doctor, nurse, clerk, etc. | ||||
Control | 0..* | ||||
Binding | For example codes, see SecurityRoleType (example to http://hl7.org/fhir/ValueSet/security-role-type )The role that a provenance agent played with respect to the activity. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
56. Provenance.agent.who | |||||
Definition | The individual, device or organization that participated in the event. | ||||
Short | (USCDI) Who participated | ||||
Comments | whoIdentity should be used when the agent is not a Resource type. | ||||
Control | 1..1 | ||||
Type | Reference(US Core Organization Profile, US Core Practitioner Profile, US Core Patient Profile, US Core PractitionerRole Profile, US Core RelatedPerson Profile, Device) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Must Support Types | Reference(US Core Organization Profile) | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
58. Provenance.agent.onBehalfOf | |||||
Definition | The individual, device, or organization for whom the change was made. | ||||
Short | (USCDI) Who the agent is representing | ||||
Comments | onBehalfOfIdentity should be used when the agent is not a Resource type. | ||||
Control | 0..1 | ||||
Type | Reference(US Core Organization Profile) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
60. Provenance.agent:ProvenanceAuthor | |||||
Slice Name | ProvenanceAuthor | ||||
Definition | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. | ||||
Short | (USCDI) Actor involved | ||||
Comments | Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
62. Provenance.agent:ProvenanceAuthor.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
64. Provenance.agent:ProvenanceAuthor.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
66. Provenance.agent:ProvenanceAuthor.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
68. Provenance.agent:ProvenanceAuthor.type | |||||
Definition | The participation the agent had with respect to the activity. | ||||
Short | (USCDI) How the agent participated | ||||
Comments | For example: author, performer, enterer, attester, etc. | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ProvenanceParticipantType (extensible to http://hl7.org/fhir/ValueSet/provenance-agent-type )The type of participation that a provenance agent played with respect to the activity. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Pattern Value | { | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
70. Provenance.agent:ProvenanceAuthor.role | |||||
Definition | The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity. | ||||
Short | What the agents role was | ||||
Comments | For example: doctor, nurse, clerk, etc. | ||||
Control | 0..* | ||||
Binding | For example codes, see SecurityRoleType (example to http://hl7.org/fhir/ValueSet/security-role-type )The role that a provenance agent played with respect to the activity. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
72. Provenance.agent:ProvenanceAuthor.who | |||||
Definition | The individual, device or organization that participated in the event. | ||||
Short | Who participated | ||||
Comments | whoIdentity should be used when the agent is not a Resource type. | ||||
Control | 1..1 | ||||
Type | Reference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
74. Provenance.agent:ProvenanceAuthor.onBehalfOf | |||||
Definition | The individual, device, or organization for whom the change was made. | ||||
Short | Who the agent is representing | ||||
Comments | onBehalfOfIdentity should be used when the agent is not a Resource type. | ||||
Control | 0..1 | ||||
Type | Reference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
76. Provenance.agent:ProvenanceTransmitter | |||||
Slice Name | ProvenanceTransmitter | ||||
Definition | The entity that provided the copy to your system. | ||||
Short | (USCDI) Actor involved | ||||
Comments | Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
78. Provenance.agent:ProvenanceTransmitter.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
80. Provenance.agent:ProvenanceTransmitter.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
82. Provenance.agent:ProvenanceTransmitter.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
84. Provenance.agent:ProvenanceTransmitter.type | |||||
Definition | The participation the agent had with respect to the activity. | ||||
Short | (USCDI) How the agent participated | ||||
Comments | For example: author, performer, enterer, attester, etc. | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ProvenanceParticipantType (extensible to http://hl7.org/fhir/ValueSet/provenance-agent-type )The type of participation that a provenance agent played with respect to the activity. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Pattern Value | { | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
86. Provenance.agent:ProvenanceTransmitter.role | |||||
Definition | The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity. | ||||
Short | What the agents role was | ||||
Comments | For example: doctor, nurse, clerk, etc. | ||||
Control | 0..* | ||||
Binding | For example codes, see SecurityRoleType (example to http://hl7.org/fhir/ValueSet/security-role-type )The role that a provenance agent played with respect to the activity. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
88. Provenance.agent:ProvenanceTransmitter.who | |||||
Definition | The individual, device or organization that participated in the event. | ||||
Short | Who participated | ||||
Comments | whoIdentity should be used when the agent is not a Resource type. | ||||
Control | 1..1 | ||||
Type | Reference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
90. Provenance.agent:ProvenanceTransmitter.onBehalfOf | |||||
Definition | The individual, device, or organization for whom the change was made. | ||||
Short | Who the agent is representing | ||||
Comments | onBehalfOfIdentity should be used when the agent is not a Resource type. | ||||
Control | 0..1 | ||||
Type | Reference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
92. Provenance.agent:assembler | |||||
Slice Name | assembler | ||||
Definition | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. | ||||
Short | Indicates the name of the system used to assemble the person's original advance care planning information into a document for exchange. | ||||
Comments | Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device ( who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists() ) | ||||
94. Provenance.agent:assembler.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
96. Provenance.agent:assembler.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
98. Provenance.agent:assembler.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
100. Provenance.agent:assembler.type | |||||
Definition | The participation the agent had with respect to the activity. | ||||
Short | (USCDI) How the agent participated | ||||
Comments | For example: author, performer, enterer, attester, etc. | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from US Core Provenance Participant Type Codes (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type ) | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Pattern Value | { | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
102. Provenance.agent:assembler.role | |||||
Definition | The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity. | ||||
Short | What the agents role was | ||||
Comments | For example: doctor, nurse, clerk, etc. | ||||
Control | 0..* | ||||
Binding | For example codes, see SecurityRoleType (example to http://hl7.org/fhir/ValueSet/security-role-type )The role that a provenance agent played with respect to the activity. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
104. Provenance.agent:assembler.who | |||||
Definition | The individual, device or organization that participated in the event. | ||||
Short | (USCDI) Who participated | ||||
Comments | whoIdentity should be used when the agent is not a Resource type. | ||||
Control | 1..1 | ||||
Type | Reference(US Core Organization Profile, US Core Practitioner Profile, US Core Patient Profile, US Core PractitionerRole Profile, US Core RelatedPerson Profile, Device) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Must Support Types | Reference(US Core Organization Profile) | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
106. Provenance.agent:assembler.onBehalfOf | |||||
Definition | The individual, device, or organization for whom the change was made. | ||||
Short | (USCDI) Who the agent is representing | ||||
Comments | onBehalfOfIdentity should be used when the agent is not a Resource type. | ||||
Control | 0..1 | ||||
Type | Reference(US Core Organization Profile) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
108. Provenance.entity | |||||
Definition | An entity used in this activity. | ||||
Short | An entity used in this activity | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
110. Provenance.entity.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
112. Provenance.entity.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
114. Provenance.entity.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
116. Provenance.entity.role | |||||
Definition | How the entity was used during the activity. | ||||
Short | derivation | revision | quotation | source | removal | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ProvenanceEntityRole (required to http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 )How an entity was used in an activity. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
118. Provenance.entity.what | |||||
Definition | Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative. | ||||
Short | Identity of entity | ||||
Comments | whatIdentity should be used for entities that are not a Resource type. | ||||
Control | 1..1 | ||||
Type | Reference(Resource) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
120. Provenance.entity.agent | |||||
Definition | The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity. | ||||
Short | Entity is attributed to this agent | ||||
Comments | A usecase where one Provenance.entity.agent is used where the Entity that was used in the creation/updating of the Target, is not in the context of the same custodianship as the Target, and thus the meaning of Provenance.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 v2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the Provenance of that Entity's use in the context of this Provenance activity. | ||||
Control | 0..* | ||||
Type | Seettp://hl7.org/fhir/StructureDefinition/Provenance#Provenance.agent | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
122. Provenance.signature | |||||
Definition | A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated. | ||||
Short | Signature on target | ||||
Control | 0..* | ||||
Type | Signature | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |