Universal API Implementation Guide - Local Development build (v1.1.19). See the Directory of published versions
Resource Profile: UAPI Provenance
| Official URL: https://fhir.developer.gene.com/StructureDefinition/uapi-provenance | Version: 1.1.19 | |||
| Active as of 2021-05-06 | Responsible: Genentech USIX PE |
Realm: 
|
Computable Name: UapiProvenance | |
This profile constrains the Provenance resource to be included in UAPI data exchanges
Usage:
- Use this Resource Profile: UAPI Bundle - Patient Consent Form Only Enrollment, UAPI Bundle - AS Enrollment
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
  signature | S | 0..1 | Signature | Signature on target |
   who | 1..1 | Reference(UAPI Patient | UAPI Practitioner | UAPI RelatedPerson) | Who signed | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| target | Σ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) |
| recorded | Σ | 1..1 | instant | When the activity was recorded / updated |
  agent | 1..* | BackboneElement | Actor involved | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| who | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
| signature | S | 0..1 | Signature | Signature on target |
| type | Σ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred) |
| when | Σ | 1..1 | instant | When the signature was created |
| who | Σ | 1..1 | Reference(UAPI Patient | UAPI Practitioner | UAPI RelatedPerson) | Who signed |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Provenance.signature.type | preferred | SignatureTypeCodes |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance | 0..* | Provenance | Who, What, When for a set of resources | |||||
| 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: CommonLanguages (preferred): IETF language tag
| |||||
| text | 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 | Σ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) | ||||
 occurred[x] | 0..1 | When the activity occurred | ||||||
| occurredPeriod | Period | |||||||
| occurredDateTime | dateTime | |||||||
| recorded | Σ | 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 | Σ | 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 | |||||
| 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 | S | 0..1 | Signature | Signature on target | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type | Σ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred) | ||||
| when | Σ | 1..1 | instant | When the signature was created | ||||
| who | Σ | 1..1 | Reference(UAPI Patient | UAPI Practitioner | UAPI RelatedPerson) | Who signed | ||||
| onBehalfOf | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | The party represented | ||||
| targetFormat | 0..1 | code | The technical format of the signed resources Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) | |||||
| sigFormat | 0..1 | code | The technical format of the signature Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) | |||||
| data | 0..1 | base64Binary | The actual signature content (XML DigSig. JWS, picture, etc.) | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Provenance.language | preferred | CommonLanguages
| ||||
| Provenance.reason | extensible | PurposeOfUse | ||||
| Provenance.activity | extensible | ProvenanceActivityType | ||||
| Provenance.agent.type | extensible | ProvenanceParticipantType | ||||
| Provenance.agent.role | example | SecurityRoleType | ||||
| Provenance.entity.role | required | ProvenanceEntityRole | ||||
| Provenance.signature.type | preferred | SignatureTypeCodes | ||||
| Provenance.signature.targetFormat | required | Mime Types (a valid code from urn:ietf:bcp:13) | ||||
| Provenance.signature.sigFormat | required | Mime Types (a valid code from urn:ietf:bcp:13) |
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 | |
| signature | S | 0..1 | Signature | Signature on target |
| who | 1..1 | Reference(UAPI Patient | UAPI Practitioner | UAPI RelatedPerson) | Who signed | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| target | Σ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) |
| recorded | Σ | 1..1 | instant | When the activity was recorded / updated |
| agent | 1..* | BackboneElement | Actor involved | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| who | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
| signature | S | 0..1 | Signature | Signature on target |
| type | Σ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred) |
| when | Σ | 1..1 | instant | When the signature was created |
| who | Σ | 1..1 | Reference(UAPI Patient | UAPI Practitioner | UAPI RelatedPerson) | Who signed |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Provenance.signature.type | preferred | SignatureTypeCodes |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance | 0..* | Provenance | Who, What, When for a set of resources | |||||
| 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: CommonLanguages (preferred): IETF language tag
| |||||
| text | 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 | Σ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific) | ||||
| occurred[x] | 0..1 | When the activity occurred | ||||||
| occurredPeriod | Period | |||||||
| occurredDateTime | dateTime | |||||||
| recorded | Σ | 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 | Σ | 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 | |||||
| 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 | S | 0..1 | Signature | Signature on target | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type | Σ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred) | ||||
| when | Σ | 1..1 | instant | When the signature was created | ||||
| who | Σ | 1..1 | Reference(UAPI Patient | UAPI Practitioner | UAPI RelatedPerson) | Who signed | ||||
| onBehalfOf | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | The party represented | ||||
| targetFormat | 0..1 | code | The technical format of the signed resources Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) | |||||
| sigFormat | 0..1 | code | The technical format of the signature Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) | |||||
| data | 0..1 | base64Binary | The actual signature content (XML DigSig. JWS, picture, etc.) | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Provenance.language | preferred | CommonLanguages
| ||||
| Provenance.reason | extensible | PurposeOfUse | ||||
| Provenance.activity | extensible | ProvenanceActivityType | ||||
| Provenance.agent.type | extensible | ProvenanceParticipantType | ||||
| Provenance.agent.role | example | SecurityRoleType | ||||
| Provenance.entity.role | required | ProvenanceEntityRole | ||||
| Provenance.signature.type | preferred | SignatureTypeCodes | ||||
| Provenance.signature.targetFormat | required | Mime Types (a valid code from urn:ietf:bcp:13) | ||||
| Provenance.signature.sigFormat | required | Mime Types (a valid code from urn:ietf:bcp:13) |
This structure is derived from Provenance
Other representations of profile: CSV, Excel, Schematron