This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: EHRProvenance

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/provenance-ehrs-rle-ehrprovenance

Defines the elements to be supported within the Provenance resource in order to conform with the Electronic Health Record System Functional Model Record Lifecycle Event standard

This profile was published on Fri, Jan 31, 2014 00:00+1100 as a draft by Health Level Seven, Inc. - EHR WG.

Formal Views of Profile Content

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

This structure is derived from Provenance.

Summary

Terminology Bindings

  • Provenance.reason SHALL come from Indicates the why the event occurred (Extensible)

Required/Prohibited Elements

  • The element Provenance.target is required
  • The element Provenance.recorded is required
  • The element Provenance.agent.role is required
  • The element Provenance.agent.type is required
  • The element Provenance.agent.reference is required
  • The element Provenance.entity.role is required
  • The element Provenance.entity.type is required
  • The element Provenance.entity.reference is required

This structure is derived from Provenance.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 1..1ProvenanceWho, What, When for a set of resources
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... target S1..*ResourceTarget Reference(s) (usually version specific)
... period S0..1PeriodWhen the activity occurred
... recorded S1..1instantWhen the activity was recorded / updated
... reason S0..1CodeableConceptReason the activity is occurring
Binding: EventPurposeOfUse (extensible)
... location S0..1LocationWhere the activity occurred, if relevant
... policy S0..*uriPolicy or plan the activity was defined by
... agent S0..*Agents involved in creating resource
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... role S1..1CodingAgents Role
Binding: ProvenanceAgentRole (extensible)
.... type S1..1CodingAgent Type
Binding: ProvenanceAgentType (required)
.... reference[x] 0..1uri, Practitioner, RelatedPerson, Patient, DeviceIdentity of agent
.... display 0..1stringHuman description of participant
... entity 0..*An entity used in this activity
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... role 1..1codederivation | revision | quotation | source
Binding: ProvenanceEntityRole (required)
.... type 1..1CodingEntity Type
Binding: ProvenanceEntityType (required)
.... reference 1..1uriIdentity of entity
.... display 0..1stringHuman description of entity
.... agent 0..1Entity is attributed to this agent
... signature 0..*SignatureSignature on target

todo

This structure is derived from Provenance.

Summary

Terminology Bindings

  • Provenance.reason SHALL come from Indicates the why the event occurred (Extensible)

Required/Prohibited Elements

  • The element Provenance.target is required
  • The element Provenance.recorded is required
  • The element Provenance.agent.role is required
  • The element Provenance.agent.type is required
  • The element Provenance.agent.reference is required
  • The element Provenance.entity.role is required
  • The element Provenance.entity.type is required
  • The element Provenance.entity.reference is required

Differential View

This structure is derived from Provenance.

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 1..1ProvenanceWho, What, When for a set of resources
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... target S1..*ResourceTarget Reference(s) (usually version specific)
... period S0..1PeriodWhen the activity occurred
... recorded S1..1instantWhen the activity was recorded / updated
... reason S0..1CodeableConceptReason the activity is occurring
Binding: EventPurposeOfUse (extensible)
... location S0..1LocationWhere the activity occurred, if relevant
... policy S0..*uriPolicy or plan the activity was defined by
... agent S0..*Agents involved in creating resource
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... role S1..1CodingAgents Role
Binding: ProvenanceAgentRole (extensible)
.... type S1..1CodingAgent Type
Binding: ProvenanceAgentType (required)
.... reference[x] 0..1uri, Practitioner, RelatedPerson, Patient, DeviceIdentity of agent
.... display 0..1stringHuman description of participant
... entity 0..*An entity used in this activity
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... role 1..1codederivation | revision | quotation | source
Binding: ProvenanceEntityRole (required)
.... type 1..1CodingEntity Type
Binding: ProvenanceEntityType (required)
.... reference 1..1uriIdentity of entity
.... display 0..1stringHuman description of entity
.... agent 0..1Entity is attributed to this agent
... signature 0..*SignatureSignature on target

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

Terminology Bindings

PathNameConformanceValueSet
Provenance.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Provenance.reasonEventPurposeOfUseextensiblePurposeOfUse
Provenance.agent.roleProvenanceAgentRoleextensibleProvenanceParticipantRole
Provenance.agent.typeProvenanceAgentTyperequiredProvenanceParticipantType
Provenance.entity.roleProvenanceEntityRolerequiredProvenanceEntityRole
Provenance.entity.typeProvenanceEntityTyperequiredResourceType

Constraints

IdPathNameDetails
.