Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OutpatientProvenance | Version: 1.0.0 | |||
| Draft as of 2026-10-13 | Computable Name: OutpatientProvenance | |||
This profile derives from the Provenance Resource, for use in the Dunedin Hospital Outpatients context. Specificly for the tracking of the merge and unmerge of patient records.
Dunedin Hospital Outpatient Provenance profile
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  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 | |
 reason |
0..* | CodeableConcept | Reason the activity is occurring Binding: Provenance Reason Type (extensible) | |
| activity |
1..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. | |
 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 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | Provenance Reason Type | 📦0.4.7 | This IG |
| Provenance.activity | Base | extensible | Provenance activity type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |
  meta |
||||
 source |
1..1 | uri | HPI Facility ID from where the record is sourced | |
 Slices for tag |
1..* | Coding | Correlation-id where the record is sourced Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  tag:correlationId |
1..1 | Coding | Tags applied to this resource | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id | |
 code |
1..1 | code | Symbol in syntax defined by the system | |
| reason |
0..* | CodeableConcept | Reason the activity is occurring Binding: Provenance Reason Type (extensible) | |
| coding |
||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: https://fhir-ig.digital.health.nz/shared-care/CodeSystem/provenance-reason-type-cs | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| activity |
1..1 | CodeableConcept | Activity that occurred | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | Provenance Reason Type | 📦0.4.7 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |||||
| source |
1..1 | uri | HPI Facility ID from where the record is sourced | |||||
| 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. | |||||
| Slices for tag |
1..* | Coding | Correlation-id where the record is sourced Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| tag:correlationId |
1..1 | 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". | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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: Provenance Reason Type (extensible) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: https://fhir-ig.digital.health.nz/shared-care/CodeSystem/provenance-reason-type-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| activity |
1..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 |
0..* | Signature | Signature on target | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Provenance.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Provenance.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Provenance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Provenance.reason | Base | extensible | Provenance Reason Type | 📦0.4.7 | This IG |
| Provenance.activity | Base | extensible | Provenance activity type | 📍4.0.1 | FHIR Std. |
| Provenance.agent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Provenance
Summary
Mandatory: 1 element(6 nested mandatory elements)
Fixed: 2 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | |
| reason |
0..* | CodeableConcept | Reason the activity is occurring Binding: Provenance Reason Type (extensible) | |
| activity |
1..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. | |
| 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 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | Provenance Reason Type | 📦0.4.7 | This IG |
| Provenance.activity | Base | extensible | Provenance activity type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |
| meta |
||||
| source |
1..1 | uri | HPI Facility ID from where the record is sourced | |
| Slices for tag |
1..* | Coding | Correlation-id where the record is sourced Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| tag:correlationId |
1..1 | Coding | Tags applied to this resource | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| reason |
0..* | CodeableConcept | Reason the activity is occurring Binding: Provenance Reason Type (extensible) | |
| coding |
||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: https://fhir-ig.digital.health.nz/shared-care/CodeSystem/provenance-reason-type-cs | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| activity |
1..1 | CodeableConcept | Activity that occurred | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | Provenance Reason Type | 📦0.4.7 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |||||
| source |
1..1 | uri | HPI Facility ID from where the record is sourced | |||||
| 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. | |||||
| Slices for tag |
1..* | Coding | Correlation-id where the record is sourced Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| tag:correlationId |
1..1 | 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". | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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: Provenance Reason Type (extensible) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: https://fhir-ig.digital.health.nz/shared-care/CodeSystem/provenance-reason-type-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| activity |
1..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 |
0..* | Signature | Signature on target | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Provenance.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Provenance.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Provenance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Provenance.reason | Base | extensible | Provenance Reason Type | 📦0.4.7 | This IG |
| Provenance.activity | Base | extensible | Provenance activity type | 📍4.0.1 | FHIR Std. |
| Provenance.agent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Provenance
Summary
Mandatory: 1 element(6 nested mandatory elements)
Fixed: 2 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron