My Health Record FHIR IG
1.3.0 - active
My Health Record FHIR IG
1.3.0 - active
My Health Record FHIR IG - Local Development build (v1.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-provenance-mhr-1 | Version: 1.3.0 | |||
| Active as of 2024-10-25 | Computable Name: MHRProvenance | |||
Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
||||
The purpose of this profile is to provide a representation of a provenance for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia. This profile is derived from the Provenance resource and describes the data structures and obligations to be met when conforming to this profile.
Usage:
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 | |||||
  id |
1..1 | id | Logical id of this artifact | |||||
 target |
SO | 1..* | Reference(MHR AllergyIntolerance | MHR Condition | MHR Explanation of Benefit | MHR Flag | MHR Observation | MHR Procedure) | Target Reference(s) (usually version specific)
| ||||
| recorded |
SO | 1..1 | instant | When the activity was recorded / updated
| ||||
 agent |
SO | 1..1 | BackboneElement | Actor involved
| ||||
  who |
SO | 1..1 | Reference(AU Core Organization) | Who participated
| ||||
 entity |
SO | 1..1 | BackboneElement | An entity used in this activity
| ||||
 role |
SO | 1..1 | code | derivation | revision | quotation | source | removal Fixed Value: source
| ||||
| what |
SO | 1..1 | Reference(MHR DocumentReference) | Identity of entity
| ||||
| reference |
SO | 0..1 | string | Literal reference, Relative, internal or absolute URL
| ||||
| display |
SO | 0..1 | string | Text alternative for the resource Fixed Value: CDA Document in XDS repository
| ||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |||||
 id |
Σ | 1..1 | id | Logical id of this artifact | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| target |
SOΣ | 1..* | Reference(MHR AllergyIntolerance | MHR Condition | MHR Explanation of Benefit | MHR Flag | MHR Observation | MHR Procedure) | Target Reference(s) (usually version specific)
| ||||
| recorded |
SOΣ | 1..1 | instant | When the activity was recorded / updated
| ||||
 agent |
SO | 1..1 | BackboneElement | Actor involved
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| who |
SOΣ | 1..1 | Reference(AU Core Organization) | Who participated
| ||||
| entity |
SO | 1..1 | BackboneElement | An entity used in this activity
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
SOΣ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Fixed Value: source
| ||||
| what |
SOΣ | 1..1 | Reference(MHR DocumentReference) | Identity of entity
| ||||
| reference |
SOΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL
| ||||
| display |
SOΣ | 0..1 | string | Text alternative for the resource Fixed Value: CDA Document in XDS repository
| ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Provenance.entity.role | required | Fixed Value: sourcehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |||||
| id |
Σ | 1..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): A human language.
| |||||
| 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 |
SOΣ | 1..* | Reference(MHR AllergyIntolerance | MHR Condition | MHR Explanation of Benefit | MHR Flag | MHR Observation | MHR Procedure) | Target Reference(s) (usually version specific)
| ||||
 occurred[x] |
0..1 | When the activity occurred | ||||||
| occurredPeriod |
Period | |||||||
| occurredDateTime |
dateTime | |||||||
| recorded |
SOΣ | 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 |
SO | 1..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 |
SOΣ | 1..1 | Reference(AU Core Organization) | Who participated
| ||||
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| entity |
SO | 1..1 | 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 |
SOΣ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Fixed Value: source
| ||||
| what |
SOΣ | 1..1 | Reference(MHR DocumentReference) | Identity of entity
| ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
SOΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL
| ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
SOΣ | 0..1 | string | Text alternative for the resource Fixed Value: CDA Document in XDS repository
| ||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| signature |
0..* | Signature | Signature on target | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Provenance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Provenance.reason | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Provenance.activity | extensible | ProvenanceActivityTypehttp://hl7.org/fhir/ValueSet/provenance-activity-typefrom the FHIR Standard | ||||
| Provenance.agent.type | extensible | ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-typefrom the FHIR Standard | ||||
| Provenance.agent.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| Provenance.entity.role | required | Fixed Value: sourcehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard | ||||
| Provenance.entity.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
This structure is derived from Provenance
Summary
Mandatory: 3 elements
Must-Support: 9 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
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 | |||||
| id |
1..1 | id | Logical id of this artifact | |||||
| target |
SO | 1..* | Reference(MHR AllergyIntolerance | MHR Condition | MHR Explanation of Benefit | MHR Flag | MHR Observation | MHR Procedure) | Target Reference(s) (usually version specific)
| ||||
| recorded |
SO | 1..1 | instant | When the activity was recorded / updated
| ||||
| agent |
SO | 1..1 | BackboneElement | Actor involved
| ||||
| who |
SO | 1..1 | Reference(AU Core Organization) | Who participated
| ||||
| entity |
SO | 1..1 | BackboneElement | An entity used in this activity
| ||||
| role |
SO | 1..1 | code | derivation | revision | quotation | source | removal Fixed Value: source
| ||||
| what |
SO | 1..1 | Reference(MHR DocumentReference) | Identity of entity
| ||||
| reference |
SO | 0..1 | string | Literal reference, Relative, internal or absolute URL
| ||||
| display |
SO | 0..1 | string | Text alternative for the resource Fixed Value: CDA Document in XDS repository
| ||||
| Documentation for this format | ||||||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |||||
| id |
Σ | 1..1 | id | Logical id of this artifact | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| target |
SOΣ | 1..* | Reference(MHR AllergyIntolerance | MHR Condition | MHR Explanation of Benefit | MHR Flag | MHR Observation | MHR Procedure) | Target Reference(s) (usually version specific)
| ||||
| recorded |
SOΣ | 1..1 | instant | When the activity was recorded / updated
| ||||
| agent |
SO | 1..1 | BackboneElement | Actor involved
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| who |
SOΣ | 1..1 | Reference(AU Core Organization) | Who participated
| ||||
| entity |
SO | 1..1 | BackboneElement | An entity used in this activity
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
SOΣ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Fixed Value: source
| ||||
| what |
SOΣ | 1..1 | Reference(MHR DocumentReference) | Identity of entity
| ||||
| reference |
SOΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL
| ||||
| display |
SOΣ | 0..1 | string | Text alternative for the resource Fixed Value: CDA Document in XDS repository
| ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Provenance.entity.role | required | Fixed Value: sourcehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |||||
| id |
Σ | 1..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): A human language.
| |||||
| 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 |
SOΣ | 1..* | Reference(MHR AllergyIntolerance | MHR Condition | MHR Explanation of Benefit | MHR Flag | MHR Observation | MHR Procedure) | Target Reference(s) (usually version specific)
| ||||
| occurred[x] |
0..1 | When the activity occurred | ||||||
| occurredPeriod |
Period | |||||||
| occurredDateTime |
dateTime | |||||||
| recorded |
SOΣ | 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 |
SO | 1..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 |
SOΣ | 1..1 | Reference(AU Core Organization) | Who participated
| ||||
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| entity |
SO | 1..1 | 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 |
SOΣ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Fixed Value: source
| ||||
| what |
SOΣ | 1..1 | Reference(MHR DocumentReference) | Identity of entity
| ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
SOΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL
| ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
SOΣ | 0..1 | string | Text alternative for the resource Fixed Value: CDA Document in XDS repository
| ||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| signature |
0..* | Signature | Signature on target | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Provenance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Provenance.reason | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Provenance.activity | extensible | ProvenanceActivityTypehttp://hl7.org/fhir/ValueSet/provenance-activity-typefrom the FHIR Standard | ||||
| Provenance.agent.type | extensible | ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-typefrom the FHIR Standard | ||||
| Provenance.agent.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| Provenance.entity.role | required | Fixed Value: sourcehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard | ||||
| Provenance.entity.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
This structure is derived from Provenance
Summary
Mandatory: 3 elements
Must-Support: 9 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.3.0 based on FHIR 4.0.1. Generated 2024-10-25
Links: Table of Contents |
QA Report
| Version History
| Report an issue or propose a change
