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: Approval Coverage

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

Coverage of an Approval, carried only for EXPLICIT_PHARMACEUTICALS, PRODUCT_CATEGORY and ALL_PHARMACEUTICALS (D15). Absent for SCHEDULE_HIERARCHY coverage: a standard CHEM/RISK Approval's coverage is re-derivable from approval-detail.formNumber and formVersion against the schedule (D6). NPPA and panel Approvals have no schedule form to derive coverage from, so their coverage is carried explicitly.

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 C 0..* Extension Approval Coverage
Constraints: sa-cov-1, sa-cov-2
Extension.extension 1..* Extension Extension
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:type This element must be supported. 1..1 Extension Extension
Extension.Slices for extension.extension:type.extension 0..0 Extension
Extension.Slices for extension.extension:type.url 1..1 uri "type"
Extension.Slices for extension.extension:type.value[x] 0..1 code Value of extension
Binding: SA Approval Coverage Type (required)
Extension.Slices for extension.extension:pharmaceutical This element must be supported. C 0..* Extension Covered pharmaceutical - only when type is EXPLICIT_PHARMACEUTICALS
Constraints: sa-cov-3
Extension.Slices for extension.extension:pharmaceutical.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode This element must be supported. 0..1 Extension Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode.extension 0..0 Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode.url 1..1 uri "pharmacode"
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId This element must be supported. 0..1 Extension Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId.extension 0..0 Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId.url 1..1 uri "ctppId"
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description This element must be supported. 0..1 Extension Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description.extension 0..0 Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description.url 1..1 uri "description"
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:pharmaceutical.url 1..1 uri "pharmaceutical"
Extension.Slices for extension.extension:pharmaceutical.value[x] 0..0 Value of extension
Extension.Slices for extension.extension:category This element must be supported. 0..1 Extension Product category - only when type is PRODUCT_CATEGORY
Extension.Slices for extension.extension:category.extension 0..0 Extension
Extension.Slices for extension.extension:category.url 1..1 uri "category"
Extension.Slices for extension.extension:category.value[x] 0..1 string Value of extension
Extension.url 1..1 uri "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/approval-coverage"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension C 0..* Extension Approval Coverage
Constraints: sa-cov-1, sa-cov-2
Extension.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension 1..* Extension 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:type This element must be supported. 1..1 Extension Extension
Extension.Slices for extension.extension:type.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:type.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:type.url 1..1 uri "type"
Extension.Slices for extension.extension:type.value[x] 0..1 code Value of extension
Binding: SA Approval Coverage Type (required)
Extension.Slices for extension.extension:pharmaceutical This element must be supported. C 0..* Extension Covered pharmaceutical - only when type is EXPLICIT_PHARMACEUTICALS
Constraints: sa-cov-3
Extension.Slices for extension.extension:pharmaceutical.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:pharmaceutical.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:pharmaceutical.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode This element must be supported. 0..1 Extension Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode.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:pharmaceutical.Slices for extension.extension:pharmacode.url 1..1 uri "pharmacode"
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId This element must be supported. 0..1 Extension Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId.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:pharmaceutical.Slices for extension.extension:ctppId.url 1..1 uri "ctppId"
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description This element must be supported. 0..1 Extension Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description.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:pharmaceutical.Slices for extension.extension:description.url 1..1 uri "description"
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:pharmaceutical.url 1..1 uri "pharmaceutical"
Extension.Slices for extension.extension:category This element must be supported. 0..1 Extension Product category - only when type is PRODUCT_CATEGORY
Extension.Slices for extension.extension:category.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:category.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:category.url 1..1 uri "category"
Extension.Slices for extension.extension:category.value[x] 0..1 string Value of extension
Extension.url 1..1 uri "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/approval-coverage"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Coverage of an Approval, carried only for EXPLICIT_PHARMACEUTICALS, PRODUCT_CATEGORY and ALL_PHARMACEUTICALS (D15). Absent for SCHEDULE_HIERARCHY coverage: a standard CHEM/RISK Approval's coverage is re-derivable from approval-detail.formNumber and formVersion against the schedule (D6). NPPA and panel Approvals have no schedule form to derive coverage from, so their coverage is carried explicitly.

  • type: code: An Extension
  • pharmacode: string: An Extension
  • ctppId: string: An Extension
  • description: string: An Extension
  • category: string: An Extension

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension C 0..* Extension Approval Coverage
Constraints: sa-cov-1, sa-cov-2
Extension.extension 1..* Extension Extension
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:type This element must be supported. 1..1 Extension Extension
Extension.Slices for extension.extension:type.extension 0..0 Extension
Extension.Slices for extension.extension:type.url 1..1 uri "type"
Extension.Slices for extension.extension:type.value[x] 0..1 code Value of extension
Binding: SA Approval Coverage Type (required)
Extension.Slices for extension.extension:pharmaceutical This element must be supported. C 0..* Extension Covered pharmaceutical - only when type is EXPLICIT_PHARMACEUTICALS
Constraints: sa-cov-3
Extension.Slices for extension.extension:pharmaceutical.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode This element must be supported. 0..1 Extension Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode.extension 0..0 Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode.url 1..1 uri "pharmacode"
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId This element must be supported. 0..1 Extension Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId.extension 0..0 Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId.url 1..1 uri "ctppId"
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description This element must be supported. 0..1 Extension Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description.extension 0..0 Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description.url 1..1 uri "description"
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:pharmaceutical.url 1..1 uri "pharmaceutical"
Extension.Slices for extension.extension:pharmaceutical.value[x] 0..0 Value of extension
Extension.Slices for extension.extension:category This element must be supported. 0..1 Extension Product category - only when type is PRODUCT_CATEGORY
Extension.Slices for extension.extension:category.extension 0..0 Extension
Extension.Slices for extension.extension:category.url 1..1 uri "category"
Extension.Slices for extension.extension:category.value[x] 0..1 string Value of extension
Extension.url 1..1 uri "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/approval-coverage"
Extension.value[x] 0..0 Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension C 0..* Extension Approval Coverage
Constraints: sa-cov-1, sa-cov-2
Extension.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension 1..* Extension 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:type This element must be supported. 1..1 Extension Extension
Extension.Slices for extension.extension:type.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:type.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:type.url 1..1 uri "type"
Extension.Slices for extension.extension:type.value[x] 0..1 code Value of extension
Binding: SA Approval Coverage Type (required)
Extension.Slices for extension.extension:pharmaceutical This element must be supported. C 0..* Extension Covered pharmaceutical - only when type is EXPLICIT_PHARMACEUTICALS
Constraints: sa-cov-3
Extension.Slices for extension.extension:pharmaceutical.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:pharmaceutical.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:pharmaceutical.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode This element must be supported. 0..1 Extension Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode.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:pharmaceutical.Slices for extension.extension:pharmacode.url 1..1 uri "pharmacode"
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:pharmacode.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId This element must be supported. 0..1 Extension Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId.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:pharmaceutical.Slices for extension.extension:ctppId.url 1..1 uri "ctppId"
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:ctppId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description This element must be supported. 0..1 Extension Extension
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description.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:pharmaceutical.Slices for extension.extension:description.url 1..1 uri "description"
Extension.Slices for extension.extension:pharmaceutical.Slices for extension.extension:description.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:pharmaceutical.url 1..1 uri "pharmaceutical"
Extension.Slices for extension.extension:category This element must be supported. 0..1 Extension Product category - only when type is PRODUCT_CATEGORY
Extension.Slices for extension.extension:category.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:category.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:category.url 1..1 uri "category"
Extension.Slices for extension.extension:category.value[x] 0..1 string Value of extension
Extension.url 1..1 uri "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/approval-coverage"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Coverage of an Approval, carried only for EXPLICIT_PHARMACEUTICALS, PRODUCT_CATEGORY and ALL_PHARMACEUTICALS (D15). Absent for SCHEDULE_HIERARCHY coverage: a standard CHEM/RISK Approval's coverage is re-derivable from approval-detail.formNumber and formVersion against the schedule (D6). NPPA and panel Approvals have no schedule form to derive coverage from, so their coverage is carried explicitly.

  • type: code: An Extension
  • pharmacode: string: An Extension
  • ctppId: string: An Extension
  • description: string: An Extension
  • category: string: An Extension

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:type.​value[x] Base required SA Approval Coverage Type 📦0.1.1 This IG

Constraints

Id Grade Path(s) Description Expression
sa-cov-1 error Extension pharmaceutical is present if, and only if, type is EXPLICIT_PHARMACEUTICALS. extension('pharmaceutical').exists() = extension('type').where(value = 'EXPLICIT_PHARMACEUTICALS').exists()
sa-cov-2 error Extension category is present if, and only if, type is PRODUCT_CATEGORY. extension('category').exists() = extension('type').where(value = 'PRODUCT_CATEGORY').exists()
sa-cov-3 error Extension.extension:pharmaceutical A pharmaceutical SHALL be identified by a pharmacode or a CTPP ID. extension.where(url='pharmacode') and extension.where(url='ctppId')