FHIR Belgium Base IG
0.1.0 -

FHIR Belgium Base IG - Local Development build (v0.1.0). See the Directory of published versions

StructureDefinition: BeProvenance

Belgian federal profile for a provenance. Note this profile does not introduce any changes from the base profile but has been created to mark its importance, specifically when FHIR is used in a non-document approach.

General use case remarks: ‘Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource.’ (cfr. the HL7 base specifications) According to the FHIR specifications, the provenance resource SHALL only be provided when no other resource already plays this role: for a Patient it SHOULD be its managing organization, provenance of an Observation SHOULD be its performer, provenance of an AllergyIntolerance SHOULD be its recorder. ‘Many other FHIR resources contain some elements that represent information about how the resource was obtained, and therefore they overlap with the functionality of the Provenance.’

Special remarks for KMEHR users: The FHIR Provenance resource in general refers to an entity that had something to do with the creation or updating of something else. In a KMEHR context, this is somewhat different – as it is ‘XML document’ based, each KMEHR message has an ‘author’ element that is responsible.

The official URL for this profile is:

https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-provenance

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Provenance

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance I0..*ProvenanceWho, What, When for a set of resources
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... target ΣI1..*Reference(Resource)Target Reference(s) (usually version specific)
... occurred[x] I0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded ΣI1..1instantWhen the activity was recorded / updated
... policy I0..*uriPolicy or plan the activity was defined by
... location I0..1Reference(Location)Where the activity occurred, if relevant
... reason I0..*CodeableConceptReason the activity is occurring
Binding: V3 Value SetPurposeOfUse (extensible)
... activity I0..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible)
... agent I1..*BackboneElementActor involved
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type ΣI0..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible)
.... role I0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example)
.... who ΣI1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
.... onBehalfOf I0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
... entity I0..*BackboneElementAn entity used in this activity
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role ΣI1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required)
.... what ΣI1..1Reference(Resource)Identity of entity
.... agent I0..*Unknown reference to #Provenance.agent
Entity is attributed to this agent
... signature I0..*SignatureSignature on target

doco Documentation for this format

This structure is derived from Provenance

Summary

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance I0..*ProvenanceWho, What, When for a set of resources
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... target ΣI1..*Reference(Resource)Target Reference(s) (usually version specific)
... occurred[x] I0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded ΣI1..1instantWhen the activity was recorded / updated
... policy I0..*uriPolicy or plan the activity was defined by
... location I0..1Reference(Location)Where the activity occurred, if relevant
... reason I0..*CodeableConceptReason the activity is occurring
Binding: V3 Value SetPurposeOfUse (extensible)
... activity I0..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible)
... agent I1..*BackboneElementActor involved
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type ΣI0..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible)
.... role I0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example)
.... who ΣI1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
.... onBehalfOf I0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
... entity I0..*BackboneElementAn entity used in this activity
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role ΣI1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required)
.... what ΣI1..1Reference(Resource)Identity of entity
.... agent I0..*Unknown reference to #Provenance.agent
Entity is attributed to this agent
... signature I0..*SignatureSignature on target

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Provenance.languagepreferredCommonLanguages
Max Binding: AllLanguages
Provenance.reasonextensiblev3.PurposeOfUse
Provenance.activityextensibleProvenanceActivityType
Provenance.agent.typeextensibleProvenanceParticipantType
Provenance.agent.roleexampleSecurityRoleType
Provenance.entity.rolerequiredProvenanceEntityRole

Constraints

Constraints

IdPathDetailsRequirements
dom-2ProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ProvenanceIf 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-4ProvenanceIf 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-5ProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ProvenanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1Provenance.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Provenance.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Provenance.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Provenance.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Provenance.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.occurred[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.recordedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.policyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.reasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.activityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.agentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.agent.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Provenance.agent.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Provenance.agent.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Provenance.agent.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Provenance.agent.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.agent.roleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.agent.whoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.agent.onBehalfOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.entityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.entity.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Provenance.entity.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Provenance.entity.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Provenance.entity.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Provenance.entity.roleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.entity.whatAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.entity.agentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.signatureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())