2nd DSTU Draft For Comment

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

Profile: EHRProvenance

The official URL for this profile is: 

http://hl7.org/fhir/Profile/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 : EHRS FM Record Lifecycle Event - Provenance

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

Summary

Terminology Bindings

  • Provenance.reason must come from Indicates the why the event occurred

Required/Prohibited Elements

  • The element Provenance is required
  • 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

Formal Views of Profile Content

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

Differential View

This structure is derived from Provenance.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 1..1
... target S1..*
... period S0..1
... recorded S1..1
... reason S0..1Binding: EventPurposeOfUse (required, extensible)
... location S0..1
... policy S0..*
... agent S0..*
.... role S1..1
.... type S1..1
.... reference S1..1
.... display 0..1
... entity 0..*
.... role 1..1
.... type 1..1
.... reference 1..1
.... display 0..1
.... agent 0..1
... integritySignature S0..1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 1..1Who, What, When for a set of resources
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... 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..*AnyTarget 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 (required, extensible)
... location S0..1LocationWhere the activity occurred, if relevant
... policy S0..*uriPolicy or plan the activity was defined by
... agent S0..*Person, organization, records, etc. involved in creating resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... role S1..1Codinge.g. author | overseer | enterer | attester | source | cc: +
Binding: ProvenanceAgentRole (preferred, extensible)
.... type S1..1Codinge.g. Resource | Person | Application | Record | Document +
Binding: ProvenanceAgentType (preferred, extensible)
.... reference S1..1uriIdentity of agent (urn or url)
.... display 0..1stringHuman description of participant
... entity 0..*An entity used in this activity
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... role 1..1codederivation | revision | quotation | source
Binding: ProvenanceEntityRole (required, not extensible)
.... type 1..1CodingResource Type, or something else
Binding: ProvenanceEntityType (preferred, extensible)
.... reference 1..1uriIdentity of participant (urn or url)
.... display 0..1stringHuman description of participant
.... agent 0..1Entity is attributed to this agent
... integritySignature S0..1stringBase64 signature (DigSig) - integrity check

XML Template

JSON Template

todo

Differential View

This structure is derived from Provenance.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 1..1
... target S1..*
... period S0..1
... recorded S1..1
... reason S0..1Binding: EventPurposeOfUse (required, extensible)
... location S0..1
... policy S0..*
... agent S0..*
.... role S1..1
.... type S1..1
.... reference S1..1
.... display 0..1
... entity 0..*
.... role 1..1
.... type 1..1
.... reference 1..1
.... display 0..1
.... agent 0..1
... integritySignature S0..1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 1..1Who, What, When for a set of resources
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... 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..*AnyTarget 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 (required, extensible)
... location S0..1LocationWhere the activity occurred, if relevant
... policy S0..*uriPolicy or plan the activity was defined by
... agent S0..*Person, organization, records, etc. involved in creating resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... role S1..1Codinge.g. author | overseer | enterer | attester | source | cc: +
Binding: ProvenanceAgentRole (preferred, extensible)
.... type S1..1Codinge.g. Resource | Person | Application | Record | Document +
Binding: ProvenanceAgentType (preferred, extensible)
.... reference S1..1uriIdentity of agent (urn or url)
.... display 0..1stringHuman description of participant
... entity 0..*An entity used in this activity
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... role 1..1codederivation | revision | quotation | source
Binding: ProvenanceEntityRole (required, not extensible)
.... type 1..1CodingResource Type, or something else
Binding: ProvenanceEntityType (preferred, extensible)
.... reference 1..1uriIdentity of participant (urn or url)
.... display 0..1stringHuman description of participant
.... agent 0..1Entity is attributed to this agent
... integritySignature S0..1stringBase64 signature (DigSig) - integrity check

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
Provenance.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Provenance.reasonEventPurposeOfUserequired (extensible)PurposeOfUse
Provenance.agent.roleProvenanceAgentRolepreferred (extensible)ProvenanceParticipantRole
Provenance.agent.typeProvenanceAgentTypepreferred (extensible)ProvenanceParticipantType
Provenance.entity.roleProvenanceEntityRolerequiredProvenanceEntityRole
Provenance.entity.typeProvenanceEntityTypepreferred (extensible)ResourceType

Constraints

IdPathNameDetails
.