StructureDefinition-UKCore-Provenance

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.

• dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
  contained.contained.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-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-6:A resource should have narrative for robust management
  text.`div`.exists()
• dom-5:If a resource is contained in another resource, it SHALL NOT have a security label
  contained.meta.security.empty()

• rim:Entity. Role, or Act
• workflow:Event
• rim:ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN]
• w3c.prov:Activity

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a
• rim:N/A

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.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a

A human language.

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).

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a

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.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a
• rim:N/A
• rim:Act.text?

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.

• rim:Entity. Role, or Act
• rim:N/A

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.

• 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()

• rim:n/a
• rim:N/A

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.

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.

• 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()

• rim:n/a
• rim:N/A

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.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())
• ref-1:SHALL have a contained resource if a local reference is provided
  reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

• rim:n/a
• rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• w5:FiveWs.what[x]
• rim:./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target OR ./participation[isNormalParticipation() and typeCode=SBJ]/role OR ./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player
• fhirauditevent:AuditEvent.entity.reference
• w3c.prov:Entity Created/Updated

The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a
• workflow:Event.occurred[x]
• w5:FiveWs.done[x]
• rim:./effectiveTime[type=IVL_TS]
• w3c.prov:Activity.startTime & Activity.endTime

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.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a
• w5:FiveWs.recorded
• rim:unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS])
• fhirauditevent:AuditEvent.recorded
• w3c.prov:Activity.when

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.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a
• rim:./inboundRelationship[isNormalActRelationship() and typeCode="SUBJ"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel
• fhirauditevent:AuditEvent.agent.policy

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())
• ref-1:SHALL have a contained resource if a local reference is provided
  reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

• rim:n/a
• rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• workflow:Event.location
• w5:FiveWs.where[x]
• rim:unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode="LOC" and determinerCode="INST"]
• fhirauditevent:AuditEvent.agent.location
• w3c.prov:Activity.location

The reason the activity took place.

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.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a
• v2:CE/CNE/CWE
• rim:CD
• orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
• workflow:Event.reasonCode
• w5:FiveWs.why[x]
• rim:unique(./reasonCode)
• fhirauditevent:AuditEvent.purposeOfEvent
• w3c.prov:Activity.Activity

The activity that took place.

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.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a
• v2:CE/CNE/CWE
• rim:CD
• orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
• workflow:Event.code
• w5:FiveWs.why[x]
• rim:Act.code
• w3c.prov:Activity.Activity

An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.

Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a
• workflow:Event.performer
• w5:FiveWs.who
• rim:./participation[isNormalParticipation()] OR ./outboundRelationship[isNormalActRelationship() and typeCode='DRIV']
• fhirauditevent:AuditEvent.agent
• w3c.prov:Agent

• rim:n/a

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.

• 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()

• rim:n/a
• rim:N/A

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.

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.

• 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()

• rim:n/a
• rim:N/A

The type of participation that a provenance agent played with respect to the activity.

For example: author, performer, enterer, attester, etc.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a
• v2:CE/CNE/CWE
• rim:CD
• orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
• workflow:Event.performer.function
• rim:.role
• fhirauditevent:AuditEvent.agent.type
• w3c.prov:Agent.Attribution

The role that a provenance agent played with respect to the activity.

For example: doctor, nurse, clerk, etc.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a
• v2:CE/CNE/CWE
• rim:CD
• orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
• rim:.typecode
• fhirauditevent:AuditEvent.agent.role

whoIdentity should be used when the agent is not a Resource type.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())
• ref-1:SHALL have a contained resource if a local reference is provided
  reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

• rim:n/a
• rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• workflow:Event.performer.actor
• w5:FiveWs.actor
• rim:.id

onBehalfOfIdentity should be used when the agent is not a Resource type.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())
• ref-1:SHALL have a contained resource if a local reference is provided
  reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

• rim:n/a
• rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• rim:Person, Practitioner, Organization, Device :* .role [classCode = RoleClassMutualRelationship; role.code and * .scopes[Role](classCode=IDENT) and *.plays [Role.Code]

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a
• rim:./subjectOf
• fhirauditevent:AuditEvent.entity
• w3c.prov:Entity

• rim:n/a

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.

• 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()

• rim:n/a
• rim:N/A

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.

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.

• 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()

• rim:n/a
• rim:N/A

How an entity was used in an activity.

Note that FHIR strings SHALL NOT exceed 1MB in size

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a
• rim:./typeCode
• fhirauditevent:AuditEvent.entity.lifecycle
• w3c.prov:Entity.role

whatIdentity should be used for entities that are not a Resource type.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())
• ref-1:SHALL have a contained resource if a local reference is provided
  reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

• rim:n/a
• rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• rim:./text/reference
• fhirauditevent:AuditEvent.entity.reference
• w3c.prov:Entity.Identity

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.

• rim:./author/role

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.

• ele-1:All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())

• rim:n/a
• rim:N/A
• rim:./signatureText