Post-Acute FHIR Based Orders
0.1.0 - STU 1 Ballot

This page is part of the Post Acute Orders FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

StructureDefinition: PAOprovenance4b

PAO Provenance Profile based on US Core

The official URL for this profile is: 

http://hl7.org/fhir/us/dme-orders/StructureDefinition/PAO-provenance4b

This section will be expanded in the STU 1 version

Formal Views of Profile Content

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

This structure is derived from USCoreProvenance

Summary

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance I0..*USCoreProvenanceUS Core Provenance
... 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(PAO ServiceRequest Profile | PAO DeviceRequest Profile | PAO MedicationRequest)The Resource this Provenance record supports
... occurred[x] I0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded SΣI1..1instantTimestamp when 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..*(Slice Definition)Actor involved
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... 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 SΣI0..1CodeableConceptHow the agent participated
Binding: US Core Provenance Participant Type Codes (extensible)
..... role I0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example)
..... who SΣI1..1Reference(US Core Practitioner Profile | PractitionerRole | RelatedPerson | US Core Patient Profile | Device | US Core Organization Profile)Who participated
..... onBehalfOf SI0..1Reference(US Core Organization Profile)Who the agent is representing
provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
.... agent:ProvenanceAuthor SI0..*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 SΣI1..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: author
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... 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
.... agent:ProvenanceTransmitter SI0..1BackboneElementActor 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 SΣI1..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: transmitter
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... 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:ProvenanceTransmitter
Entity is attributed to this agent
... signature I0..*SignatureSignature on target

doco Documentation for this format

This structure is derived from USCoreProvenance

Summary

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance I0..*USCoreProvenanceUS Core Provenance
... 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(PAO ServiceRequest Profile | PAO DeviceRequest Profile | PAO MedicationRequest)The Resource this Provenance record supports
... occurred[x] I0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded SΣI1..1instantTimestamp when 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..*(Slice Definition)Actor involved
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... 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 SΣI0..1CodeableConceptHow the agent participated
Binding: US Core Provenance Participant Type Codes (extensible)
..... role I0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example)
..... who SΣI1..1Reference(US Core Practitioner Profile | PractitionerRole | RelatedPerson | US Core Patient Profile | Device | US Core Organization Profile)Who participated
..... onBehalfOf SI0..1Reference(US Core Organization Profile)Who the agent is representing
provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
.... agent:ProvenanceAuthor SI0..*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 SΣI1..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: author
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... 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
.... agent:ProvenanceTransmitter SI0..1BackboneElementActor 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 SΣI1..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: transmitter
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... 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:ProvenanceTransmitter
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 / Code
Provenance.languagepreferredCommonLanguages
Max Binding: AllLanguages
Provenance.reasonextensiblev3.PurposeOfUse
Provenance.activityextensibleProvenanceActivityType
Provenance.agent.typeextensibleUSCoreProvenancePaticipantTypeCodes
Provenance.agent.roleexampleSecurityRoleType
Provenance.agent:ProvenanceAuthor.typeextensiblePattern: author
Provenance.agent:ProvenanceAuthor.roleexampleSecurityRoleType
Provenance.agent:ProvenanceTransmitter.typeextensiblePattern: transmitter
Provenance.agent:ProvenanceTransmitter.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())
provenance-1Provenance.agent.onBehalfOfonBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
: ($this.agent.who.resolve().is Practitioner or Device) implies exists()
ele-1Provenance.agent:ProvenanceAuthorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.agent:ProvenanceAuthor.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Provenance.agent:ProvenanceAuthor.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Provenance.agent:ProvenanceAuthor.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Provenance.agent:ProvenanceAuthor.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Provenance.agent:ProvenanceAuthor.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.agent:ProvenanceAuthor.roleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.agent:ProvenanceAuthor.whoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.agent:ProvenanceAuthor.onBehalfOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.agent:ProvenanceTransmitterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.agent:ProvenanceTransmitter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Provenance.agent:ProvenanceTransmitter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Provenance.agent:ProvenanceTransmitter.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Provenance.agent:ProvenanceTransmitter.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Provenance.agent:ProvenanceTransmitter.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.agent:ProvenanceTransmitter.roleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.agent:ProvenanceTransmitter.whoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Provenance.agent:ProvenanceTransmitter.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())

This section will be expanded in the STU 1 version