STU 2 Ballot
This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) v1.6.0. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/us/daf/StructureDefinition/daf-provenance
This profile was published on Thu Aug 21 00:00:00 AEST 2014 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Provenance
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Provenance | 0..* | |||
 target | S | 1..* | Reference(Resource) | |
| recorded | S | 1..1 | instant | |
 agent | S | 1..* | BackboneElement | |
 role | S | 1..1 | Coding | |
| actor | S | 0..1 | Reference(Practitioner | RelatedPerson | Patient | Device | Organization) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | I | 0..* | Who, What, When for a set of resources dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
 id | ∑ | 0..1 | id | Logical id of this artifact |
 meta | ∑ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 target | S | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) |
| period | ∑ | 0..1 | Period | When the activity occurred |
| recorded | S | 1..1 | instant | When the activity was recorded / updated |
| reason | ∑ | 0..* | Coding | Reason the activity is occurring Binding: PurposeOfUse (extensible) |
| activity | ∑ | 0..1 | Coding | Activity that occurred Binding: ProvenanceEventCurrentState (extensible) |
| location | ∑ | 0..1 | Reference(Location) | Where the activity occurred, if relevant |
| policy | ∑ | 0..* | uri | Policy or plan the activity was defined by |
| agent | S | 1..* | BackboneElement | Actor involved |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
| role | S | 1..1 | Coding | What the agents involvement was Binding: ProvenanceParticipantRole (extensible) |
| actor | S | 0..1 | Reference(Practitioner | RelatedPerson | Patient | Device | Organization) | Individual, device or organization playing role |
| userId | ∑ | 0..1 | Identifier | Authorization-system identifier for the agent |
| relatedAgent | ∑ | 0..* | BackboneElement | Track delegation between agents |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
| type | ∑ | 1..1 | CodeableConcept | Type of relationship between agents Binding: v3 Code System RoleLinkType (example) |
| target | ∑ | 1..1 | uri | Reference to other agent in this resource by identifier |
| entity | ∑ | 0..* | BackboneElement | An entity used in this activity |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
| role | ∑ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required) |
| type | ∑ | 1..1 | Coding | The type of resource in this entity Binding: ResourceType (extensible) |
| reference | ∑ | 1..1 | uri | Identity of entity |
| display | ∑ | 0..1 | string | Human description of entity |
| agent | ∑ | 0..* | Unknown reference to #Provenance:dafprovenance.agent Entity is attributed to this agent | |
| signature | ∑ | 0..* | Signature | Signature on target |
| Documentation for this format | ||||
yet to be done: Xml template
yet to be done: Json template
This structure is derived from Provenance.
Differential View
This structure is derived from Provenance.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | |||
| target | S | 1..* | Reference(Resource) | |
| recorded | S | 1..1 | instant | |
| agent | S | 1..* | BackboneElement | |
| role | S | 1..1 | Coding | |
| actor | S | 0..1 | Reference(Practitioner | RelatedPerson | Patient | Device | Organization) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | I | 0..* | Who, What, When for a set of resources dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
| id | ∑ | 0..1 | id | Logical id of this artifact |
| meta | ∑ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| target | S | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) |
| period | ∑ | 0..1 | Period | When the activity occurred |
| recorded | S | 1..1 | instant | When the activity was recorded / updated |
| reason | ∑ | 0..* | Coding | Reason the activity is occurring Binding: PurposeOfUse (extensible) |
| activity | ∑ | 0..1 | Coding | Activity that occurred Binding: ProvenanceEventCurrentState (extensible) |
| location | ∑ | 0..1 | Reference(Location) | Where the activity occurred, if relevant |
| policy | ∑ | 0..* | uri | Policy or plan the activity was defined by |
| agent | S | 1..* | BackboneElement | Actor involved |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
| role | S | 1..1 | Coding | What the agents involvement was Binding: ProvenanceParticipantRole (extensible) |
| actor | S | 0..1 | Reference(Practitioner | RelatedPerson | Patient | Device | Organization) | Individual, device or organization playing role |
| userId | ∑ | 0..1 | Identifier | Authorization-system identifier for the agent |
| relatedAgent | ∑ | 0..* | BackboneElement | Track delegation between agents |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
| type | ∑ | 1..1 | CodeableConcept | Type of relationship between agents Binding: v3 Code System RoleLinkType (example) |
| target | ∑ | 1..1 | uri | Reference to other agent in this resource by identifier |
| entity | ∑ | 0..* | BackboneElement | An entity used in this activity |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
| role | ∑ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required) |
| type | ∑ | 1..1 | Coding | The type of resource in this entity Binding: ResourceType (extensible) |
| reference | ∑ | 1..1 | uri | Identity of entity |
| display | ∑ | 0..1 | string | Human description of entity |
| agent | ∑ | 0..* | Unknown reference to #Provenance:dafprovenance.agent Entity is attributed to this agent | |
| signature | ∑ | 0..* | Signature | Signature on target |
| Documentation for this format | ||||
XML Template
yet to be done: Xml template
JSON Template
yet to be done: Json template
| Path | Name | Conformance | ValueSet |
| Provenance.language | Common Languages | extensible | Common Languages |
| Provenance.reason | PurposeOfUse | extensible | PurposeOfUse |
| Provenance.activity | ProvenanceEventCurrentState | extensible | ProvenanceEventCurrentState |
| Provenance.agent.role | ProvenanceParticipantRole | extensible | ProvenanceParticipantRole |
| Provenance.agent.relatedAgent.type | v3 Code System RoleLinkType | example | v3 Code System RoleLinkType |
| Provenance.entity.role | ProvenanceEntityRole | required | ProvenanceEntityRole |
| Provenance.entity.type | ResourceType | extensible | ResourceType |
| Id | Path | Details | Requirements |
| dom-2 | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained) | |
| dom-1 | Provenance | If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text) | |
| dom-4 | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)) | |
| dom-3 | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])) |
© HL7.org 2011+. DAF STU 2 Ballot (v1.6.0-9635) generated on Thu, Aug 11, 2016 20:06+1000. QA Page
Links: Search |
Version History |
Table of Contents |
|
Propose a change 