HSAAP Special Authority FHIR Implementation Guide
0.1.1 - draft New Zealand flag

HSAAP Special Authority FHIR Implementation Guide - Local Development build (v0.1.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: Submission Context

Official URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/submission-context Version: 0.1.1
Draft as of 2026-10-16 Computable Name: SubmissionContext

Asserted source context for a submission. This is provenance only: it MUST NOT override the authenticated identity, and MUST NOT be used for authentication or authorisation.

The SOAP to FHIR Broker populates this from the legacy HL7 payload (ZSS.1, ZSL.1-ZSL.4, ZSU.1). Direct FHIR clients may omit it, in which case the API derives the values from the authenticated channel context.

Note: the detailed design places this extension on Bundle. In FHIR R4 Bundle is a Resource, not a DomainResource, and cannot carry extensions, so this guide places it on the focal Claim. See Design Notes.

Context of Use

    This extension may be used on the following element(s)

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension Submission Context
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:practiceId This element must be supported. 0..1 Extension Legacy Practice Id (ZSS.1)
Extension.Slices for extension.extension:practiceId.extension 0..0 Extension
Extension.Slices for extension.extension:practiceId.url 1..1 uri "practiceId"
Extension.Slices for extension.extension:practiceId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:workstationId This element must be supported. 0..1 Extension PMS workstation / PC Id (ZSL.1)
Extension.Slices for extension.extension:workstationId.extension 0..0 Extension
Extension.Slices for extension.extension:workstationId.url 1..1 uri "workstationId"
Extension.Slices for extension.extension:workstationId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:sourceSystemId This element must be supported. 0..1 Extension PMS Id (ZSL.2)
Extension.Slices for extension.extension:sourceSystemId.extension 0..0 Extension
Extension.Slices for extension.extension:sourceSystemId.url 1..1 uri "sourceSystemId"
Extension.Slices for extension.extension:sourceSystemId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:sourceSystemVendor This element must be supported. 0..1 Extension Client vendor (ZSL.3)
Extension.Slices for extension.extension:sourceSystemVendor.extension 0..0 Extension
Extension.Slices for extension.extension:sourceSystemVendor.url 1..1 uri "sourceSystemVendor"
Extension.Slices for extension.extension:sourceSystemVendor.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:sourceSubmittedAt This element must be supported. 0..1 Extension Client timestamp, source system clock (ZSL.4)
Extension.Slices for extension.extension:sourceSubmittedAt.extension 0..0 Extension
Extension.Slices for extension.extension:sourceSubmittedAt.url 1..1 uri "sourceSubmittedAt"
Extension.Slices for extension.extension:sourceSubmittedAt.value[x] 0..1 dateTime Value of extension
Extension.Slices for extension.extension:submittingUserName This element must be supported. 0..1 Extension PMS login user name (ZSU.1) - not an authenticated identity
Extension.Slices for extension.extension:submittingUserName.extension 0..0 Extension
Extension.Slices for extension.extension:submittingUserName.url 1..1 uri "submittingUserName"
Extension.Slices for extension.extension:submittingUserName.value[x] 0..1 string Value of extension
Extension.url 1..1 uri "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/submission-context"
Extension.value[x] 0..0 Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension Submission Context
Extension.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:practiceId This element must be supported. 0..1 Extension Legacy Practice Id (ZSS.1)
Extension.Slices for extension.extension:practiceId.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:practiceId.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:practiceId.url 1..1 uri "practiceId"
Extension.Slices for extension.extension:practiceId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:workstationId This element must be supported. 0..1 Extension PMS workstation / PC Id (ZSL.1)
Extension.Slices for extension.extension:workstationId.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:workstationId.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:workstationId.url 1..1 uri "workstationId"
Extension.Slices for extension.extension:workstationId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:sourceSystemId This element must be supported. 0..1 Extension PMS Id (ZSL.2)
Extension.Slices for extension.extension:sourceSystemId.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:sourceSystemId.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:sourceSystemId.url 1..1 uri "sourceSystemId"
Extension.Slices for extension.extension:sourceSystemId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:sourceSystemVendor This element must be supported. 0..1 Extension Client vendor (ZSL.3)
Extension.Slices for extension.extension:sourceSystemVendor.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:sourceSystemVendor.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:sourceSystemVendor.url 1..1 uri "sourceSystemVendor"
Extension.Slices for extension.extension:sourceSystemVendor.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:sourceSubmittedAt This element must be supported. 0..1 Extension Client timestamp, source system clock (ZSL.4)
Extension.Slices for extension.extension:sourceSubmittedAt.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:sourceSubmittedAt.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:sourceSubmittedAt.url 1..1 uri "sourceSubmittedAt"
Extension.Slices for extension.extension:sourceSubmittedAt.value[x] 0..1 dateTime Value of extension
Extension.Slices for extension.extension:submittingUserName This element must be supported. 0..1 Extension PMS login user name (ZSU.1) - not an authenticated identity
Extension.Slices for extension.extension:submittingUserName.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:submittingUserName.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:submittingUserName.url 1..1 uri "submittingUserName"
Extension.Slices for extension.extension:submittingUserName.value[x] 0..1 string Value of extension
Extension.url 1..1 uri "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/submission-context"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Asserted source context for a submission. This is provenance only: it MUST NOT override the authenticated identity, and MUST NOT be used for authentication or authorisation. The SOAP to FHIR Broker populates this from the legacy HL7 payload (ZSS.1, ZSL.1-ZSL.4, ZSU.1). Direct FHIR clients may omit it, in which case the API derives the values from the authenticated channel context. Note: the detailed design places this extension on Bundle. In FHIR R4 Bundle is a Resource, not a DomainResource, and cannot carry extensions, so this guide places it on the focal Claim. See Design Notes.

  • practiceId: string: An Extension
  • workstationId: string: An Extension
  • sourceSystemId: string: An Extension
  • sourceSystemVendor: string: An Extension
  • sourceSubmittedAt: dateTime: An Extension
  • submittingUserName: string: An Extension

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension Submission Context
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:practiceId This element must be supported. 0..1 Extension Legacy Practice Id (ZSS.1)
Extension.Slices for extension.extension:practiceId.extension 0..0 Extension
Extension.Slices for extension.extension:practiceId.url 1..1 uri "practiceId"
Extension.Slices for extension.extension:practiceId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:workstationId This element must be supported. 0..1 Extension PMS workstation / PC Id (ZSL.1)
Extension.Slices for extension.extension:workstationId.extension 0..0 Extension
Extension.Slices for extension.extension:workstationId.url 1..1 uri "workstationId"
Extension.Slices for extension.extension:workstationId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:sourceSystemId This element must be supported. 0..1 Extension PMS Id (ZSL.2)
Extension.Slices for extension.extension:sourceSystemId.extension 0..0 Extension
Extension.Slices for extension.extension:sourceSystemId.url 1..1 uri "sourceSystemId"
Extension.Slices for extension.extension:sourceSystemId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:sourceSystemVendor This element must be supported. 0..1 Extension Client vendor (ZSL.3)
Extension.Slices for extension.extension:sourceSystemVendor.extension 0..0 Extension
Extension.Slices for extension.extension:sourceSystemVendor.url 1..1 uri "sourceSystemVendor"
Extension.Slices for extension.extension:sourceSystemVendor.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:sourceSubmittedAt This element must be supported. 0..1 Extension Client timestamp, source system clock (ZSL.4)
Extension.Slices for extension.extension:sourceSubmittedAt.extension 0..0 Extension
Extension.Slices for extension.extension:sourceSubmittedAt.url 1..1 uri "sourceSubmittedAt"
Extension.Slices for extension.extension:sourceSubmittedAt.value[x] 0..1 dateTime Value of extension
Extension.Slices for extension.extension:submittingUserName This element must be supported. 0..1 Extension PMS login user name (ZSU.1) - not an authenticated identity
Extension.Slices for extension.extension:submittingUserName.extension 0..0 Extension
Extension.Slices for extension.extension:submittingUserName.url 1..1 uri "submittingUserName"
Extension.Slices for extension.extension:submittingUserName.value[x] 0..1 string Value of extension
Extension.url 1..1 uri "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/submission-context"
Extension.value[x] 0..0 Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension Submission Context
Extension.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:practiceId This element must be supported. 0..1 Extension Legacy Practice Id (ZSS.1)
Extension.Slices for extension.extension:practiceId.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:practiceId.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:practiceId.url 1..1 uri "practiceId"
Extension.Slices for extension.extension:practiceId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:workstationId This element must be supported. 0..1 Extension PMS workstation / PC Id (ZSL.1)
Extension.Slices for extension.extension:workstationId.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:workstationId.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:workstationId.url 1..1 uri "workstationId"
Extension.Slices for extension.extension:workstationId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:sourceSystemId This element must be supported. 0..1 Extension PMS Id (ZSL.2)
Extension.Slices for extension.extension:sourceSystemId.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:sourceSystemId.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:sourceSystemId.url 1..1 uri "sourceSystemId"
Extension.Slices for extension.extension:sourceSystemId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:sourceSystemVendor This element must be supported. 0..1 Extension Client vendor (ZSL.3)
Extension.Slices for extension.extension:sourceSystemVendor.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:sourceSystemVendor.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:sourceSystemVendor.url 1..1 uri "sourceSystemVendor"
Extension.Slices for extension.extension:sourceSystemVendor.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:sourceSubmittedAt This element must be supported. 0..1 Extension Client timestamp, source system clock (ZSL.4)
Extension.Slices for extension.extension:sourceSubmittedAt.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:sourceSubmittedAt.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:sourceSubmittedAt.url 1..1 uri "sourceSubmittedAt"
Extension.Slices for extension.extension:sourceSubmittedAt.value[x] 0..1 dateTime Value of extension
Extension.Slices for extension.extension:submittingUserName This element must be supported. 0..1 Extension PMS login user name (ZSU.1) - not an authenticated identity
Extension.Slices for extension.extension:submittingUserName.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:submittingUserName.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:submittingUserName.url 1..1 uri "submittingUserName"
Extension.Slices for extension.extension:submittingUserName.value[x] 0..1 string Value of extension
Extension.url 1..1 uri "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/submission-context"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Asserted source context for a submission. This is provenance only: it MUST NOT override the authenticated identity, and MUST NOT be used for authentication or authorisation. The SOAP to FHIR Broker populates this from the legacy HL7 payload (ZSS.1, ZSL.1-ZSL.4, ZSU.1). Direct FHIR clients may omit it, in which case the API derives the values from the authenticated channel context. Note: the detailed design places this extension on Bundle. In FHIR R4 Bundle is a Resource, not a DomainResource, and cannot carry extensions, so this guide places it on the focal Claim. See Design Notes.

  • practiceId: string: An Extension
  • workstationId: string: An Extension
  • sourceSystemId: string: An Extension
  • sourceSystemVendor: string: An Extension
  • sourceSubmittedAt: dateTime: An Extension
  • submittingUserName: string: An Extension

 

Other representations of profile: CSV, Excel, Schematron

Constraints

Id Grade Path(s) Description Expression