1.0.0 - Build CI
SaraAlert - Local Development build (v1.0.0). See the Directory of published versions
Defining URL: | http://saraalert.org/StructureDefinition/sara-alert-provenance |
Version: | 1.0.0 |
Name: | SaraAlertProvenance |
Title: | Sara Alert Provenance Profile |
Status: | Active as of 2021-12-01T10:26:21-05:00 |
Definition: | The Sara Alert Provenance profile represents a monitoree history item. |
Publisher: | The MITRE Corporation |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://saraalert.org/StructureDefinition/sara-alert-provenance
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Provenance
This structure is derived from Provenance
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
meta | ||||
lastUpdated | S | 1..1 | instant | When the resource version last changed |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
comment | S | 0..1 | string | Comment URL: http://saraalert.org/StructureDefinition/comment |
history-type | S | 0..1 | string | History Type URL: http://saraalert.org/StructureDefinition/history-type |
original-id | S | 0..1 | positiveInt | Original ID URL: http://saraalert.org/StructureDefinition/original-id |
target | S | 1..1 | Reference(Resource) | Target Reference(s) (usually version specific) |
recorded | S | 1..1 | instant | When the activity was recorded / updated |
agent | ||||
who | S | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
onBehalfOf | S | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | SΣ | 1..1 | instant | When the resource version last changed |
source | Σ | 0..1 | uri | Identifies where the resource comes from |
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
comment | S | 0..1 | string | Comment URL: http://saraalert.org/StructureDefinition/comment |
history-type | S | 0..1 | string | History Type URL: http://saraalert.org/StructureDefinition/history-type |
original-id | S | 0..1 | positiveInt | Original ID URL: http://saraalert.org/StructureDefinition/original-id |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
target | SΣ | 1..1 | Reference(Resource) | Target Reference(s) (usually version specific) |
occurred[x] | 0..1 | When the activity occurred | ||
occurredPeriod | Period | |||
occurredDateTime | dateTime | |||
recorded | SΣ | 1..1 | instant | When the activity was recorded / updated |
policy | 0..* | uri | Policy or plan the activity was defined by | |
location | 0..1 | Reference(Location) | Where the activity occurred, if relevant | |
reason | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. | |
activity | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. | |
agent | 1..* | BackboneElement | Actor involved | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. |
role | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
who | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
onBehalfOf | S | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing |
entity | 0..* | BackboneElement | An entity used in this activity | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. |
what | Σ | 1..1 | Reference(Resource) | Identity of entity |
agent | 0..* | See agent (Provenance) | Entity is attributed to this agent | |
signature | 0..* | Signature | Signature on target | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
meta | Σ | 0..1 | Meta | Metadata about the resource |
lastUpdated | Σ | 1..1 | instant | When the resource version last changed |
comment | 0..1 | string | Comment URL: http://saraalert.org/StructureDefinition/comment | |
history-type | 0..1 | string | History Type URL: http://saraalert.org/StructureDefinition/history-type | |
original-id | 0..1 | positiveInt | Original ID URL: http://saraalert.org/StructureDefinition/original-id | |
target | Σ | 1..1 | Reference(Resource) | Target Reference(s) (usually version specific) |
recorded | Σ | 1..1 | instant | When the activity was recorded / updated |
agent | 1..* | BackboneElement | Actor involved | |
who | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
onBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
Documentation for this format |
This structure is derived from Provenance
Differential View
This structure is derived from Provenance
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
meta | ||||
lastUpdated | S | 1..1 | instant | When the resource version last changed |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
comment | S | 0..1 | string | Comment URL: http://saraalert.org/StructureDefinition/comment |
history-type | S | 0..1 | string | History Type URL: http://saraalert.org/StructureDefinition/history-type |
original-id | S | 0..1 | positiveInt | Original ID URL: http://saraalert.org/StructureDefinition/original-id |
target | S | 1..1 | Reference(Resource) | Target Reference(s) (usually version specific) |
recorded | S | 1..1 | instant | When the activity was recorded / updated |
agent | ||||
who | S | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
onBehalfOf | S | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | SΣ | 1..1 | instant | When the resource version last changed |
source | Σ | 0..1 | uri | Identifies where the resource comes from |
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
comment | S | 0..1 | string | Comment URL: http://saraalert.org/StructureDefinition/comment |
history-type | S | 0..1 | string | History Type URL: http://saraalert.org/StructureDefinition/history-type |
original-id | S | 0..1 | positiveInt | Original ID URL: http://saraalert.org/StructureDefinition/original-id |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
target | SΣ | 1..1 | Reference(Resource) | Target Reference(s) (usually version specific) |
occurred[x] | 0..1 | When the activity occurred | ||
occurredPeriod | Period | |||
occurredDateTime | dateTime | |||
recorded | SΣ | 1..1 | instant | When the activity was recorded / updated |
policy | 0..* | uri | Policy or plan the activity was defined by | |
location | 0..1 | Reference(Location) | Where the activity occurred, if relevant | |
reason | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. | |
activity | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. | |
agent | 1..* | BackboneElement | Actor involved | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. |
role | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
who | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
onBehalfOf | S | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing |
entity | 0..* | BackboneElement | An entity used in this activity | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. |
what | Σ | 1..1 | Reference(Resource) | Identity of entity |
agent | 0..* | See agent (Provenance) | Entity is attributed to this agent | |
signature | 0..* | Signature | Signature on target | |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Provenance.meta.security | extensible | All Security Labels |
Provenance.meta.tag | example | CommonTags |
Provenance.language | preferred | CommonLanguages Max Binding: AllLanguages |
Provenance.reason | extensible | PurposeOfUse |
Provenance.activity | extensible | ProvenanceActivityType |
Provenance.agent.type | extensible | ProvenanceParticipantType |
Provenance.agent.role | example | SecurityRoleType |
Provenance.entity.role | required | ProvenanceEntityRole |
Id | Path | Details | Requirements |
dom-2 | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | Provenance | If 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-4 | Provenance | If 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-5 | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Provenance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | Provenance.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.meta.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Provenance.meta.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Provenance.meta.versionId | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.meta.lastUpdated | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.meta.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.meta.profile | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.meta.security | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.meta.tag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Provenance.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Provenance.extension:comment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Provenance.extension:comment | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Provenance.extension:history-type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Provenance.extension:history-type | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Provenance.extension:original-id | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Provenance.extension:original-id | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Provenance.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Provenance.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Provenance.target | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.occurred[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.recorded | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.policy | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.reason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.activity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.agent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.agent.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Provenance.agent.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Provenance.agent.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Provenance.agent.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Provenance.agent.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.agent.role | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.agent.who | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.agent.onBehalfOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.entity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.entity.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Provenance.entity.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Provenance.entity.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Provenance.entity.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Provenance.entity.role | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.entity.what | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.entity.agent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Provenance.signature | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |