International Patient Access
0.1.0 - draft

International Patient Access, published by HL7. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/grahamegrieve/ipa-candidate/ and changes regularly. See the Directory of published versions

StructureDefinition: IPAProvenance

Minimum expectations for a Provenance resource when accessed via a International Patient Access API

The official URL for this profile is:

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-provenance

Formal Views of Profile Content

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

This structure is derived from Provenance

Summary

Mandatory: 4 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

This structure is derived from Provenance

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 SΣI1..*Reference(Resource)The Resource this Provenance record applies to
... occurred[x] I0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded SΣ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 SI1..*BackboneElementActor involved
ipa-prov-1: At least one of the agents must be the author
.... 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 SΣI1..1Reference(IPA-Practitioner | IPA-PractitionerRole | IPA-RelatedPerson | IPA-Patient | IPA-Device | IPA-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

Mandatory: 4 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Provenance

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 SΣI1..*Reference(Resource)The Resource this Provenance record applies to
... occurred[x] I0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded SΣ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 SI1..*BackboneElementActor involved
ipa-prov-1: At least one of the agents must be the author
.... 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 SΣI1..1Reference(IPA-Practitioner | IPA-PractitionerRole | IPA-RelatedPerson | IPA-Patient | IPA-Device | IPA-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
ipa-prov-1Provenance.agentAt least one of the agents must be the author
: select(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/provenance-participant-type' and code = 'author').exists()).exists()