ProvenanceProfile
⚠️ This is an introduction of our profile ProvenanceProfile
Metadata
These are the details for this resource:
Resource content
These are different views on this resource:
ProvenanceProfile (Provenance) | I | Provenance | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | I | 0..1 | Narrative |
contained | I | 0..* | Resource |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
target | Σ I | 1..* | Reference(Resource)Fixed Value |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | stringFixed Value |
type | Σ | 0..0 | uriBindingFixed Value |
identifier | Σ I | 0..0 | Identifier |
display | Σ I | 0..0 | string |
occurred[x] | 0..0 | ||
recorded | Σ | 0..1 | instant |
policy | 0..0 | uri | |
location | I | 0..0 | Reference(Location) |
authorization | 0..0 | CodeableReference() | |
activity | 0..0 | CodeableConcept | |
basedOn | I | 0..0 | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) |
patient | I | 0..0 | Reference(Patient) |
encounter | I | 0..0 | Reference(Encounter) |
agent | Σ I | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
type | Σ | 1..1 | CodeableConcept |
role | 0..0 | CodeableConcept | |
who | Σ I | 1..1 | Reference(CFBPractitioner) |
onBehalfOf | I | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient) |
entity | Σ | 0..0 | BackboneElement |
signature | 0..* | Signature | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
type | Σ I | 0..0 | CodingBinding |
when | Σ | 0..0 | instant |
who | Σ I | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..0 | string |
type | Σ | 0..0 | uriBinding |
identifier | Σ I | 0..1 | Identifier |
display | Σ I | 0..1 | string |
onBehalfOf | Σ I | 0..0 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
targetFormat | 0..1 | codeBinding | |
sigFormat | 0..1 | codeBinding | |
data | 1..1 | base64Binary |
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. |
Cardinality | 0...* |
Alias | History, Event, Activity |
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. |
Invariants |
|
Mappings |
|
Provenance.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
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. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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 its narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
Provenance.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | IETF language tag for a human language |
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). |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have a 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. |
Invariants |
|
Mappings |
|
Provenance.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained 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. |
Mappings |
|
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 managable, 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
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 managable, 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content |
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. |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
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. |
Cardinality | 1...* |
Type | Reference(Resource) |
Summary | True |
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. |
Invariants |
|
Fixed Value | { "reference": "https://luxith-etab.org/fhir/StructureDefinition/lu/LuxithDocumentReferenceProfile", "type": "StructureDefinition" } |
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
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 managable, 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Fixed Value | https://luxith-etab.org/fhir/StructureDefinition/lu/LuxithDocumentReferenceProfile |
Mappings |
|
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). |
Cardinality | 0...0 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
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 known RESTful URL) or by resolving the target of the reference. |
Invariants |
|
Fixed Value | StructureDefinition |
Mappings |
|
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. |
Cardinality | 0...0 |
Type | Identifier |
Summary | True |
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). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
Invariants |
|
Mappings |
|
Provenance.target.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...0 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Provenance.occurred[x] | |
Definition | The period during which the activity occurred. |
Cardinality | 0...0 |
Type | Period |
Comments | The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time. |
Invariants |
|
Mappings |
|
Provenance.recorded | |
Definition | The instant of time at which the activity was recorded. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
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. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...0 |
Type | uri |
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. |
Invariants |
|
Mappings |
|
Provenance.location | |
Definition | Where the activity occurred, if relevant. |
Cardinality | 0...0 |
Type | Reference(Location) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Provenance.authorization | |
Definition | The authorization (e.g., PurposeOfUse) that was used during the event being recorded. |
Cardinality | 0...0 |
Type | CodeableReference() |
Binding | The authorized purposeOfUse for the activity. |
Alias | PurposeOfEvent |
Requirements | Record of any relevant security context, not restricted to purposeOfUse valueSet. May include security compartments, refrain, obligation, or other security tags. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...0 |
Type | CodeableConcept |
Binding | The activity that took place. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Provenance.basedOn | |
Definition | Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon. |
Cardinality | 0...0 |
Type | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Provenance.patient | |
Definition | The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity. |
Cardinality | 0...0 |
Type | Reference(Patient) |
Requirements | When the .patient is populated it shall be accurate to the subject of the target data. The .patient shall not be populated when the target data created/updated (.target) by the activity does not involve a subject. Note that when the patient is an agent, they will be recorded as an agent. When the Patient resource is Created, Updated, or Deleted it will be recorded as an entity. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Provenance.encounter | |
Definition | This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests). |
Cardinality | 0...0 |
Type | Reference(Encounter) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 1...* |
Type | BackboneElement |
Summary | True |
Requirements | An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. |
Comments | Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
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 managable, 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
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 managable, 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Provenance.agent.type | |
Definition | The Functional Role of the agent with respect to the activity. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | The type of participation that a provenance agent played with respect to the activity. |
Summary | True |
Requirements | Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models. |
Comments | For example: assembler, author, prescriber, signer, investigator, etc. |
Invariants |
|
Mappings |
|
Provenance.agent.role | |
Definition | The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity. |
Cardinality | 0...0 |
Type | CodeableConcept |
Binding | The role that a provenance agent played with respect to the activity. |
Requirements | Structural roles reflect the structural aspects of relationships between entities. Structural roles describe prerequisites, feasibilities, or competences for acts. Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.. |
Comments | For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc. |
Invariants |
|
Mappings |
|
Provenance.agent.who | |
Definition | Indicates who or what performed in the event. |
Cardinality | 1...1 |
Type | Reference(CFBPractitioner) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Provenance.agent.onBehalfOf | |
Definition | The agent that delegated authority to perform the activity performed by the agent.who element. |
Cardinality | 1...1 |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Provenance.entity | |
Definition | An entity used in this activity. |
Cardinality | 0...0 |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
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 managable, 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
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 managable, 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Provenance.entity.role | |
Definition | How the entity was used during the activity. |
Cardinality | 1...1 |
Type | code |
Binding | How an entity was used in an activity. |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
Invariants |
|
Mappings |
|
Provenance.entity.what | |
Definition | Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative. |
Cardinality | 1...1 |
Type | Reference(Resource) |
Summary | True |
Comments | whatIdentity should be used for entities that are not a Resource type. |
Invariants |
|
Mappings |
|
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 used the entity. |
Cardinality | 0...* |
Type | see (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. |
Mappings |
|
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. |
Cardinality | 0...* |
Type | Signature |
Comments | The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form. |
Invariants |
|
Mappings |
|
Provenance.signature.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Provenance.signature.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 managable, 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Provenance.signature.type | |
Definition | An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document. |
Cardinality | 0...0 |
Type | Coding |
Binding | An indication of the reason that an entity signed the object. |
Summary | True |
Comments | Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication". |
Invariants |
|
Mappings |
|
Provenance.signature.when | |
Definition | When the digital signature was signed. |
Cardinality | 0...0 |
Type | instant |
Summary | True |
Comments | This should agree with the information in the signature. |
Invariants |
|
Mappings |
|
Provenance.signature.who | |
Definition | A reference to an application-usable description of the identity that signed (e.g. the signature used their private key). |
Cardinality | 1...1 |
Type | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
Summary | True |
Comments | This should agree with the information in the signature. |
Invariants |
|
Mappings |
|
Provenance.signature.who.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Provenance.signature.who.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 managable, 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Provenance.signature.who.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. |
Cardinality | 0...0 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Provenance.signature.who.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). |
Cardinality | 0...0 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
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 known RESTful URL) or by resolving the target of the reference. |
Invariants |
|
Mappings |
|
Provenance.signature.who.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. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
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). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
Invariants |
|
Mappings |
|
Provenance.signature.who.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Provenance.signature.onBehalfOf | |
Definition | A reference to an application-usable description of the identity that is represented by the signature. |
Cardinality | 0...0 |
Type | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
Summary | True |
Requirements | used when the signature is on behalf of a non-signer. |
Comments | The party that can't sign. For example a child. |
Invariants |
|
Mappings |
|
Provenance.signature.targetFormat | |
Definition | A mime type that indicates the technical format of the target resources signed by the signature. |
Cardinality | 0...1 |
Type | code |
Binding | BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) |
Comments | "xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here. |
Invariants |
|
Mappings |
|
Provenance.signature.sigFormat | |
Definition | A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc. |
Cardinality | 0...1 |
Type | code |
Binding | BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) |
Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
Invariants |
|
Mappings |
|
Provenance.signature.data | |
Definition | The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty. |
Cardinality | 1...1 |
Type | base64Binary |
Comments | Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) "Detached Signature" form. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <url value="https://luxith-etab.org/fhir/StructureDefinition/lu/ProvenanceProfile" /> <name value="ProvenanceProfile" /> <status value="draft" /> <description value="Contain key for document encryption" /> <fhirVersion value="5.0.0" /> <kind value="resource" /> <abstract value="false" /> <type value="Provenance" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Provenance" /> <derivation value="constraint" /> <differential> <element id="Provenance.target"> <path value="Provenance.target" /> <fixedReference> <reference value="https://luxith-etab.org/fhir/StructureDefinition/lu/LuxithDocumentReferenceProfile" /> <type value="StructureDefinition" /> </fixedReference> </element> <element id="Provenance.target.type"> <path value="Provenance.target.type" /> <max value="0" /> </element> <element id="Provenance.target.identifier"> <path value="Provenance.target.identifier" /> <max value="0" /> </element> <element id="Provenance.target.display"> <path value="Provenance.target.display" /> <max value="0" /> </element> <element id="Provenance.occurred[x]"> <path value="Provenance.occurred[x]" /> <max value="0" /> </element> <element id="Provenance.policy"> <path value="Provenance.policy" /> <max value="0" /> </element> <element id="Provenance.location"> <path value="Provenance.location" /> <max value="0" /> </element> <element id="Provenance.authorization"> <path value="Provenance.authorization" /> <max value="0" /> </element> <element id="Provenance.activity"> <path value="Provenance.activity" /> <max value="0" /> </element> <element id="Provenance.basedOn"> <path value="Provenance.basedOn" /> <max value="0" /> </element> <element id="Provenance.patient"> <path value="Provenance.patient" /> <max value="0" /> </element> <element id="Provenance.encounter"> <path value="Provenance.encounter" /> <max value="0" /> </element> <element id="Provenance.agent.type"> <path value="Provenance.agent.type" /> <code> <system value="http://terminology.hl7.org/CodeSystem/provenance-participant-type" /> <code value="author" /> <display value="Author" /> </code> <min value="1" /> </element> <element id="Provenance.agent.role"> <path value="Provenance.agent.role" /> <max value="0" /> </element> <element id="Provenance.agent.who"> <path value="Provenance.agent.who" /> <type> <code value="Reference" /> <targetProfile value="https://luxith-etab.org/fhir/StructureDefinition/lu/CFBPractitioner" /> </type> </element> <element id="Provenance.agent.onBehalfOf"> <path value="Provenance.agent.onBehalfOf" /> <min value="1" /> </element> <element id="Provenance.entity"> <path value="Provenance.entity" /> <max value="0" /> </element> <element id="Provenance.signature.type"> <path value="Provenance.signature.type" /> <max value="0" /> </element> <element id="Provenance.signature.when"> <path value="Provenance.signature.when" /> <max value="0" /> </element> <element id="Provenance.signature.who"> <path value="Provenance.signature.who" /> <min value="1" /> </element> <element id="Provenance.signature.who.reference"> <path value="Provenance.signature.who.reference" /> <max value="0" /> </element> <element id="Provenance.signature.who.type"> <path value="Provenance.signature.who.type" /> <max value="0" /> </element> <element id="Provenance.signature.onBehalfOf"> <path value="Provenance.signature.onBehalfOf" /> <max value="0" /> </element> <element id="Provenance.signature.data"> <path value="Provenance.signature.data" /> <min value="1" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "url": "https://luxith-etab.org/fhir/StructureDefinition/lu/ProvenanceProfile", "name": "ProvenanceProfile", "status": "draft", "description": "Contain key for document encryption", "fhirVersion": "5.0.0", "kind": "resource", "abstract": false, "type": "Provenance", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Provenance", "derivation": "constraint", "differential": { "element": [ { "id": "Provenance.target", "path": "Provenance.target", "fixedReference": { "reference": "https://luxith-etab.org/fhir/StructureDefinition/lu/LuxithDocumentReferenceProfile", "type": "StructureDefinition" } }, { "id": "Provenance.target.type", "path": "Provenance.target.type", "max": "0" }, { "id": "Provenance.target.identifier", "path": "Provenance.target.identifier", "max": "0" }, { "id": "Provenance.target.display", "path": "Provenance.target.display", "max": "0" }, { "id": "Provenance.occurred[x]", "path": "Provenance.occurred[x]", "max": "0" }, { "id": "Provenance.policy", "path": "Provenance.policy", "max": "0" }, { "id": "Provenance.location", "path": "Provenance.location", "max": "0" }, { "id": "Provenance.authorization", "path": "Provenance.authorization", "max": "0" }, { "id": "Provenance.activity", "path": "Provenance.activity", "max": "0" }, { "id": "Provenance.basedOn", "path": "Provenance.basedOn", "max": "0" }, { "id": "Provenance.patient", "path": "Provenance.patient", "max": "0" }, { "id": "Provenance.encounter", "path": "Provenance.encounter", "max": "0" }, { "id": "Provenance.agent.type", "path": "Provenance.agent.type", "code": [ { "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type", "code": "author", "display": "Author" } ], "min": 1 }, { "id": "Provenance.agent.role", "path": "Provenance.agent.role", "max": "0" }, { "id": "Provenance.agent.who", "path": "Provenance.agent.who", "type": [ { "code": "Reference", "targetProfile": [ "https://luxith-etab.org/fhir/StructureDefinition/lu/CFBPractitioner" ] } ] }, { "id": "Provenance.agent.onBehalfOf", "path": "Provenance.agent.onBehalfOf", "min": 1 }, { "id": "Provenance.entity", "path": "Provenance.entity", "max": "0" }, { "id": "Provenance.signature.type", "path": "Provenance.signature.type", "max": "0" }, { "id": "Provenance.signature.when", "path": "Provenance.signature.when", "max": "0" }, { "id": "Provenance.signature.who", "path": "Provenance.signature.who", "min": 1 }, { "id": "Provenance.signature.who.reference", "path": "Provenance.signature.who.reference", "max": "0" }, { "id": "Provenance.signature.who.type", "path": "Provenance.signature.who.type", "max": "0" }, { "id": "Provenance.signature.onBehalfOf", "path": "Provenance.signature.onBehalfOf", "max": "0" }, { "id": "Provenance.signature.data", "path": "Provenance.signature.data", "min": 1 } ] } }