HSAAP Special Authority FHIR Implementation Guide
0.1.1 - draft
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
| Official URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-claim | Version: 0.1.1 | |||
| Draft as of 2026-10-16 | Computable Name: SAClaim | |||
A Special Authority Application: a request for authorisation of funded pharmaceuticals in advance of their supply, i.e.
a Claim with use = preauthorization. Submitted inside an SA Submission Bundle to Claim/$submit.
QuestionnaireResponse referenced from supportingInfo.provider references the Applicant - the same Practitioner as QuestionnaireResponse.author. FHIR R4 Claim has
no requestor element; the custom requestor search parameter evaluates Claim.provider, so
requestor:Practitioner.identifier searches and _include=Claim:requestor resolve to the Applicant.identifier carries the Application Number only (D23). It is absent on submission and is populated by the API.item is used only for NPPA and panel approval Applications, where no form declares coverage. Standard Special
Authority Applications SHALL NOT supply item; coverage is derived from the resolved form at decision time (D6).insurance is mandatory in FHIR R4 Claim. It carries a logical reference to the Pharmaceutical Schedule and has no
other meaning (see Design Notes).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: ![]() |
|---|---|---|---|---|
![]() |
0..* | Claim | Claim, Pre-determination or Pre-authorization | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | 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 | |
![]() ![]() ![]() |
0..1 | (Complex) | Asserted source context - provenance only URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/submission-context | |
![]() ![]() ![]() |
C | 0..1 | (Complex) | Populated by the API on Application Enquiry. SHALL NOT be sent on submission. URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/application-status Constraints: sa-appstatus-1 |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..1 | Identifier | Application Number - populated by the API, absent on submission | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/application-number (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |
![]() ![]() |
1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active (extensions allowed) | |
![]() ![]() |
1..1 | CodeableConcept | Category or discipline Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. Required Pattern: | |
![]() ![]() |
1..1 | code | claim | preauthorization | predetermination Binding: Use (required): The purpose of the Claim: predetermination, preauthorization, claim. Required Pattern: preauthorization (extensions allowed) | |
![]() ![]() |
1..1 | Reference(SA Patient) | The recipient of the products and services | |
![]() ![]() |
1..1 | dateTime | Resource creation date | |
![]() ![]() |
1..1 | Reference(SA Practitioner) | The Applicant - same Practitioner as QuestionnaireResponse.author | |
![]() ![]() |
1..1 | CodeableConcept | Desired processing ugency Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred. Required Pattern: | |
![]() ![]() |
1..* | BackboneElement | Supporting information Slice: Unordered, Open by pattern:category Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Information instance identifier | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes. | |
![]() ![]() ![]() |
1..1 | BackboneElement | Supporting information | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Information instance identifier | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes. Required Pattern: | |
![]() ![]() ![]() ![]() |
1..1 | Reference(SA QuestionnaireResponse) | Data to be provided | |
![]() ![]() |
1..1 | BackboneElement | Mandatory in FHIR R4 - logical reference to the Pharmaceutical Schedule only | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | positiveInt | Insurance instance identifier Required Pattern: 1 (extensions allowed) | |
![]() ![]() ![]() |
1..1 | boolean | Coverage to be used for adjudication Fixed Value: true (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | Reference(Coverage) | Insurance information | |
![]() ![]() ![]() ![]() |
1..1 | string | Text alternative for the resource Required Pattern: Pharmaceutical Schedule (extensions allowed) | |
![]() ![]() |
C | 0..* | BackboneElement | Requested pharmaceuticals - NPPA and panel approval Applications only Constraints: sa-claim-1 |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | positiveInt | Item instance identifier | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system 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 | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | NZMT CTPP ID (preferred) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://nzmt.org.nz (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Pharmac Pharmacode | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Claim.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Claim.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
| Claim.type | Base | extensible | Claim Type Codes | 📍4.0.1 | FHIR Std. |
| Claim.use | Base | required | Use | 📍4.0.1 | FHIR Std. |
| Claim.priority | Base | example | Process Priority Codes | 📍4.0.1 | FHIR Std. |
| Claim.payee.type | Base | example | PayeeType | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo.category | Base | example | Claim Information Category Codes | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo:questionnaireResponse.category | Base | example | Claim Information Category Codes | 📍4.0.1 | FHIR Std. |
| Claim.diagnosis.diagnosis[x] | Base | example | ICD-10 Codes | 📍4.0.1 | FHIR Std. |
| Claim.procedure.procedure[x] | Base | example | ICD-10 Procedure Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| sa-claim-1 | error | Claim.item | A requested pharmaceutical SHALL be identified by a CTPP ID or a Pharmacode. |
productOrService.coding.where(system = 'http://nzmt.org.nz' or system = 'https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode').exists()
|
This structure is derived from Claim
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Claim | Claim, Pre-determination or Pre-authorization | |
![]() ![]() |
0..* | 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 | |
![]() ![]() ![]() |
0..1 | (Complex) | Asserted source context - provenance only URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/submission-context | |
![]() ![]() ![]() |
0..1 | (Complex) | Populated by the API on Application Enquiry. SHALL NOT be sent on submission. URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/application-status | |
![]() ![]() |
0..1 | Identifier | Application Number - populated by the API, absent on submission | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/application-number (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
1..1 | code | active | cancelled | draft | entered-in-error Required Pattern: active (extensions allowed) | |
![]() ![]() |
1..1 | CodeableConcept | Category or discipline Required Pattern: | |
![]() ![]() |
0..0 | More granular claim type | ||
![]() ![]() |
1..1 | code | claim | preauthorization | predetermination Required Pattern: preauthorization (extensions allowed) | |
![]() ![]() |
1..1 | Reference(SA Patient) | The recipient of the products and services | |
![]() ![]() |
0..0 | Relevant time frame for the claim | ||
![]() ![]() |
1..1 | dateTime | Resource creation date | |
![]() ![]() |
0..0 | Author of the claim | ||
![]() ![]() |
0..0 | Target | ||
![]() ![]() |
1..1 | Reference(SA Practitioner) | The Applicant - same Practitioner as QuestionnaireResponse.author | |
![]() ![]() |
1..1 | CodeableConcept | Desired processing ugency Required Pattern: | |
![]() ![]() |
0..0 | For whom to reserve funds | ||
![]() ![]() |
0..0 | Prior or corollary claims | ||
![]() ![]() |
0..0 | Prescription authorizing services and products | ||
![]() ![]() |
0..0 | Original prescription if superseded by fulfiller | ||
![]() ![]() |
0..0 | Recipient of benefits payable | ||
![]() ![]() |
0..0 | Treatment referral | ||
![]() ![]() |
0..0 | Servicing facility | ||
![]() ![]() |
0..0 | Members of the care team | ||
![]() ![]() |
1..* | BackboneElement | Supporting information Slice: Unordered, Open by pattern:category Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
1..1 | BackboneElement | Supporting information | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of the supplied information Required Pattern: | |
![]() ![]() ![]() ![]() |
1..1 | Reference(SA QuestionnaireResponse) | Data to be provided | |
![]() ![]() |
0..0 | Pertinent diagnosis information | ||
![]() ![]() |
0..0 | Clinical procedures performed | ||
![]() ![]() |
1..1 | BackboneElement | Mandatory in FHIR R4 - logical reference to the Pharmaceutical Schedule only | |
![]() ![]() ![]() |
1..1 | positiveInt | Insurance instance identifier Required Pattern: 1 (extensions allowed) | |
![]() ![]() ![]() |
1..1 | boolean | Coverage to be used for adjudication Fixed Value: true (no extensions allowed) | |
![]() ![]() ![]() |
0..0 | Pre-assigned Claim number | ||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..0 | Literal reference, Relative, internal or absolute URL | ||
![]() ![]() ![]() ![]() |
1..1 | string | Text alternative for the resource Required Pattern: Pharmaceutical Schedule (extensions allowed) | |
![]() ![]() ![]() |
0..0 | Additional provider contract number | ||
![]() ![]() ![]() |
0..0 | Prior authorization reference number | ||
![]() ![]() ![]() |
0..0 | Adjudication results | ||
![]() ![]() |
0..0 | Details of the event | ||
![]() ![]() |
C | 0..* | BackboneElement | Requested pharmaceuticals - NPPA and panel approval Applications only Constraints: sa-claim-1 |
![]() ![]() ![]() |
0..0 | Applicable careTeam members | ||
![]() ![]() ![]() |
0..0 | Applicable diagnoses | ||
![]() ![]() ![]() |
0..0 | Applicable procedures | ||
![]() ![]() ![]() |
0..0 | Applicable exception and supporting information | ||
![]() ![]() ![]() |
0..0 | Revenue or cost center code | ||
![]() ![]() ![]() |
0..0 | Benefit classification | ||
![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system 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 | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | NZMT CTPP ID (preferred) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://nzmt.org.nz (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Pharmac Pharmacode | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() |
0..0 | Product or service billing modifiers | ||
![]() ![]() ![]() |
0..0 | Program the product or service is provided under | ||
![]() ![]() ![]() |
0..0 | Date or dates of service or product delivery | ||
![]() ![]() ![]() |
0..0 | Place of service or where product was supplied | ||
![]() ![]() ![]() |
0..0 | Fee, charge or cost per item | ||
![]() ![]() ![]() |
0..0 | Price scaling factor | ||
![]() ![]() ![]() |
0..0 | Total item cost | ||
![]() ![]() ![]() |
0..0 | Unique device identifier | ||
![]() ![]() ![]() |
0..0 | Anatomical location | ||
![]() ![]() ![]() |
0..0 | Anatomical sub-location | ||
![]() ![]() ![]() |
0..0 | Encounters related to this billed item | ||
![]() ![]() ![]() |
0..0 | Product or service provided | ||
![]() ![]() |
0..0 | Total claim cost | ||
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| sa-claim-1 | error | Claim.item | A requested pharmaceutical SHALL be identified by a CTPP ID or a Pharmacode. |
productOrService.coding.where(system = 'http://nzmt.org.nz' or system = 'https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode').exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Claim | Claim, Pre-determination or Pre-authorization | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | 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 | |||||
![]() ![]() ![]() |
0..1 | (Complex) | Asserted source context - provenance only URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/submission-context | |||||
![]() ![]() ![]() |
C | 0..1 | (Complex) | Populated by the API on Application Enquiry. SHALL NOT be sent on submission. URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/application-status Constraints: sa-appstatus-1 | ||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..1 | Identifier | Application Number - populated by the API, absent on submission | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/application-number (no extensions allowed) | |||||
![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |||||
![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active (extensions allowed) | |||||
![]() ![]() |
1..1 | CodeableConcept | Category or discipline Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. Required Pattern: | |||||
![]() ![]() |
1..1 | code | claim | preauthorization | predetermination Binding: Use (required): The purpose of the Claim: predetermination, preauthorization, claim. Required Pattern: preauthorization (extensions allowed) | |||||
![]() ![]() |
1..1 | Reference(SA Patient) | The recipient of the products and services | |||||
![]() ![]() |
1..1 | dateTime | Resource creation date | |||||
![]() ![]() |
1..1 | Reference(SA Practitioner) | The Applicant - same Practitioner as QuestionnaireResponse.author | |||||
![]() ![]() |
1..1 | CodeableConcept | Desired processing ugency Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred. Required Pattern: | |||||
![]() ![]() |
1..* | BackboneElement | Supporting information Slice: Unordered, Open by pattern:category Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Information instance identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Type of information Binding: ExceptionCodes (example): The valuset used for additional information codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | When it occurred | ||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
0..1 | Data to be provided | ||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Explanation for the information Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth. | |||||
![]() ![]() ![]() |
1..1 | BackboneElement | Supporting information | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Information instance identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes. Required Pattern: | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Type of information Binding: ExceptionCodes (example): The valuset used for additional information codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | When it occurred | ||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
1..1 | Reference(SA QuestionnaireResponse) | Data to be provided | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Explanation for the information Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth. | |||||
![]() ![]() |
1..1 | BackboneElement | Mandatory in FHIR R4 - logical reference to the Pharmaceutical Schedule only | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Insurance instance identifier Required Pattern: 1 (extensions allowed) | |||||
![]() ![]() ![]() |
1..1 | boolean | Coverage to be used for adjudication Fixed Value: true (no extensions allowed) | |||||
![]() ![]() ![]() |
1..1 | Reference(Coverage) | Insurance information | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() ![]() |
1..1 | string | Text alternative for the resource Required Pattern: Pharmaceutical Schedule (extensions allowed) | |||||
![]() ![]() |
C | 0..* | BackboneElement | Requested pharmaceuticals - NPPA and panel approval Applications only Constraints: sa-claim-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Item instance identifier | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system 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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | NZMT CTPP ID (preferred) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://nzmt.org.nz (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Pharmac Pharmacode | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | Count of products or services Constraints: sqty-1 | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Claim.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Claim.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Claim.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Claim.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
| Claim.type | Base | extensible | Claim Type Codes | 📍4.0.1 | FHIR Std. |
| Claim.use | Base | required | Use | 📍4.0.1 | FHIR Std. |
| Claim.priority | Base | example | Process Priority Codes | 📍4.0.1 | FHIR Std. |
| Claim.related.relationship | Base | example | Example Related Claim Relationship Codes | 📍4.0.1 | FHIR Std. |
| Claim.payee.type | Base | example | PayeeType | 📍4.0.1 | FHIR Std. |
| Claim.careTeam.role | Base | example | Claim Care Team Role Codes | 📍4.0.1 | FHIR Std. |
| Claim.careTeam.qualification | Base | example | Example Provider Qualification Codes | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo.category | Base | example | Claim Information Category Codes | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo.code | Base | example | Exception Codes | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo.reason | Base | example | Missing Tooth Reason Codes | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo:questionnaireResponse.category | Base | example | Claim Information Category Codes | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo:questionnaireResponse.code | Base | example | Exception Codes | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo:questionnaireResponse.reason | Base | example | Missing Tooth Reason Codes | 📍4.0.1 | FHIR Std. |
| Claim.diagnosis.diagnosis[x] | Base | example | ICD-10 Codes | 📍4.0.1 | FHIR Std. |
| Claim.diagnosis.type | Base | example | Example Diagnosis Type Codes | 📍4.0.1 | FHIR Std. |
| Claim.diagnosis.onAdmission | Base | example | Example Diagnosis on Admission Codes | 📍4.0.1 | FHIR Std. |
| Claim.diagnosis.packageCode | Base | example | Example Diagnosis Related Group Codes | 📍4.0.1 | FHIR Std. |
| Claim.procedure.type | Base | example | Example Procedure Type Codes | 📍4.0.1 | FHIR Std. |
| Claim.procedure.procedure[x] | Base | example | ICD-10 Procedure Codes | 📍4.0.1 | FHIR Std. |
| Claim.insurance.coverage.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Claim.accident.type | Base | extensible | ActIncidentCode | 📦3.0.0 | THO v7.4 |
| Claim.item.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.revenue | Base | example | Example Revenue Center Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.category | Base | example | Benefit Category Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.modifier | Base | example | Modifier type Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.programCode | Base | example | Example Program Reason Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.subDetail.revenue | Base | example | Example Revenue Center Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.subDetail.category | Base | example | Benefit Category Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.subDetail.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.subDetail.modifier | Base | example | Modifier type Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.subDetail.programCode | Base | example | Example Program Reason Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| sa-claim-1 | error | Claim.item | A requested pharmaceutical SHALL be identified by a CTPP ID or a Pharmacode. |
productOrService.coding.where(system = 'http://nzmt.org.nz' or system = 'https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode').exists()
|
This structure is derived from Claim
Summary
Mandatory: 4 elements(7 nested mandatory elements)
Must-Support: 16 elements
Fixed: 4 elements
Prohibited: 39 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Claim | Claim, Pre-determination or Pre-authorization | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | 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 | |
![]() ![]() ![]() |
0..1 | (Complex) | Asserted source context - provenance only URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/submission-context | |
![]() ![]() ![]() |
C | 0..1 | (Complex) | Populated by the API on Application Enquiry. SHALL NOT be sent on submission. URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/application-status Constraints: sa-appstatus-1 |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..1 | Identifier | Application Number - populated by the API, absent on submission | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/application-number (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |
![]() ![]() |
1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active (extensions allowed) | |
![]() ![]() |
1..1 | CodeableConcept | Category or discipline Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. Required Pattern: | |
![]() ![]() |
1..1 | code | claim | preauthorization | predetermination Binding: Use (required): The purpose of the Claim: predetermination, preauthorization, claim. Required Pattern: preauthorization (extensions allowed) | |
![]() ![]() |
1..1 | Reference(SA Patient) | The recipient of the products and services | |
![]() ![]() |
1..1 | dateTime | Resource creation date | |
![]() ![]() |
1..1 | Reference(SA Practitioner) | The Applicant - same Practitioner as QuestionnaireResponse.author | |
![]() ![]() |
1..1 | CodeableConcept | Desired processing ugency Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred. Required Pattern: | |
![]() ![]() |
1..* | BackboneElement | Supporting information Slice: Unordered, Open by pattern:category Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Information instance identifier | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes. | |
![]() ![]() ![]() |
1..1 | BackboneElement | Supporting information | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Information instance identifier | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes. Required Pattern: | |
![]() ![]() ![]() ![]() |
1..1 | Reference(SA QuestionnaireResponse) | Data to be provided | |
![]() ![]() |
1..1 | BackboneElement | Mandatory in FHIR R4 - logical reference to the Pharmaceutical Schedule only | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | positiveInt | Insurance instance identifier Required Pattern: 1 (extensions allowed) | |
![]() ![]() ![]() |
1..1 | boolean | Coverage to be used for adjudication Fixed Value: true (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | Reference(Coverage) | Insurance information | |
![]() ![]() ![]() ![]() |
1..1 | string | Text alternative for the resource Required Pattern: Pharmaceutical Schedule (extensions allowed) | |
![]() ![]() |
C | 0..* | BackboneElement | Requested pharmaceuticals - NPPA and panel approval Applications only Constraints: sa-claim-1 |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | positiveInt | Item instance identifier | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system 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 | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | NZMT CTPP ID (preferred) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://nzmt.org.nz (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Pharmac Pharmacode | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Claim.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Claim.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
| Claim.type | Base | extensible | Claim Type Codes | 📍4.0.1 | FHIR Std. |
| Claim.use | Base | required | Use | 📍4.0.1 | FHIR Std. |
| Claim.priority | Base | example | Process Priority Codes | 📍4.0.1 | FHIR Std. |
| Claim.payee.type | Base | example | PayeeType | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo.category | Base | example | Claim Information Category Codes | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo:questionnaireResponse.category | Base | example | Claim Information Category Codes | 📍4.0.1 | FHIR Std. |
| Claim.diagnosis.diagnosis[x] | Base | example | ICD-10 Codes | 📍4.0.1 | FHIR Std. |
| Claim.procedure.procedure[x] | Base | example | ICD-10 Procedure Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| sa-claim-1 | error | Claim.item | A requested pharmaceutical SHALL be identified by a CTPP ID or a Pharmacode. |
productOrService.coding.where(system = 'http://nzmt.org.nz' or system = 'https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode').exists()
|
Differential View
This structure is derived from Claim
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Claim | Claim, Pre-determination or Pre-authorization | |
![]() ![]() |
0..* | 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 | |
![]() ![]() ![]() |
0..1 | (Complex) | Asserted source context - provenance only URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/submission-context | |
![]() ![]() ![]() |
0..1 | (Complex) | Populated by the API on Application Enquiry. SHALL NOT be sent on submission. URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/application-status | |
![]() ![]() |
0..1 | Identifier | Application Number - populated by the API, absent on submission | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/application-number (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
1..1 | code | active | cancelled | draft | entered-in-error Required Pattern: active (extensions allowed) | |
![]() ![]() |
1..1 | CodeableConcept | Category or discipline Required Pattern: | |
![]() ![]() |
0..0 | More granular claim type | ||
![]() ![]() |
1..1 | code | claim | preauthorization | predetermination Required Pattern: preauthorization (extensions allowed) | |
![]() ![]() |
1..1 | Reference(SA Patient) | The recipient of the products and services | |
![]() ![]() |
0..0 | Relevant time frame for the claim | ||
![]() ![]() |
1..1 | dateTime | Resource creation date | |
![]() ![]() |
0..0 | Author of the claim | ||
![]() ![]() |
0..0 | Target | ||
![]() ![]() |
1..1 | Reference(SA Practitioner) | The Applicant - same Practitioner as QuestionnaireResponse.author | |
![]() ![]() |
1..1 | CodeableConcept | Desired processing ugency Required Pattern: | |
![]() ![]() |
0..0 | For whom to reserve funds | ||
![]() ![]() |
0..0 | Prior or corollary claims | ||
![]() ![]() |
0..0 | Prescription authorizing services and products | ||
![]() ![]() |
0..0 | Original prescription if superseded by fulfiller | ||
![]() ![]() |
0..0 | Recipient of benefits payable | ||
![]() ![]() |
0..0 | Treatment referral | ||
![]() ![]() |
0..0 | Servicing facility | ||
![]() ![]() |
0..0 | Members of the care team | ||
![]() ![]() |
1..* | BackboneElement | Supporting information Slice: Unordered, Open by pattern:category Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
1..1 | BackboneElement | Supporting information | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of the supplied information Required Pattern: | |
![]() ![]() ![]() ![]() |
1..1 | Reference(SA QuestionnaireResponse) | Data to be provided | |
![]() ![]() |
0..0 | Pertinent diagnosis information | ||
![]() ![]() |
0..0 | Clinical procedures performed | ||
![]() ![]() |
1..1 | BackboneElement | Mandatory in FHIR R4 - logical reference to the Pharmaceutical Schedule only | |
![]() ![]() ![]() |
1..1 | positiveInt | Insurance instance identifier Required Pattern: 1 (extensions allowed) | |
![]() ![]() ![]() |
1..1 | boolean | Coverage to be used for adjudication Fixed Value: true (no extensions allowed) | |
![]() ![]() ![]() |
0..0 | Pre-assigned Claim number | ||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..0 | Literal reference, Relative, internal or absolute URL | ||
![]() ![]() ![]() ![]() |
1..1 | string | Text alternative for the resource Required Pattern: Pharmaceutical Schedule (extensions allowed) | |
![]() ![]() ![]() |
0..0 | Additional provider contract number | ||
![]() ![]() ![]() |
0..0 | Prior authorization reference number | ||
![]() ![]() ![]() |
0..0 | Adjudication results | ||
![]() ![]() |
0..0 | Details of the event | ||
![]() ![]() |
C | 0..* | BackboneElement | Requested pharmaceuticals - NPPA and panel approval Applications only Constraints: sa-claim-1 |
![]() ![]() ![]() |
0..0 | Applicable careTeam members | ||
![]() ![]() ![]() |
0..0 | Applicable diagnoses | ||
![]() ![]() ![]() |
0..0 | Applicable procedures | ||
![]() ![]() ![]() |
0..0 | Applicable exception and supporting information | ||
![]() ![]() ![]() |
0..0 | Revenue or cost center code | ||
![]() ![]() ![]() |
0..0 | Benefit classification | ||
![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system 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 | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | NZMT CTPP ID (preferred) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://nzmt.org.nz (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Pharmac Pharmacode | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() |
0..0 | Product or service billing modifiers | ||
![]() ![]() ![]() |
0..0 | Program the product or service is provided under | ||
![]() ![]() ![]() |
0..0 | Date or dates of service or product delivery | ||
![]() ![]() ![]() |
0..0 | Place of service or where product was supplied | ||
![]() ![]() ![]() |
0..0 | Fee, charge or cost per item | ||
![]() ![]() ![]() |
0..0 | Price scaling factor | ||
![]() ![]() ![]() |
0..0 | Total item cost | ||
![]() ![]() ![]() |
0..0 | Unique device identifier | ||
![]() ![]() ![]() |
0..0 | Anatomical location | ||
![]() ![]() ![]() |
0..0 | Anatomical sub-location | ||
![]() ![]() ![]() |
0..0 | Encounters related to this billed item | ||
![]() ![]() ![]() |
0..0 | Product or service provided | ||
![]() ![]() |
0..0 | Total claim cost | ||
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| sa-claim-1 | error | Claim.item | A requested pharmaceutical SHALL be identified by a CTPP ID or a Pharmacode. |
productOrService.coding.where(system = 'http://nzmt.org.nz' or system = 'https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode').exists()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Claim | Claim, Pre-determination or Pre-authorization | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | 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 | |||||
![]() ![]() ![]() |
0..1 | (Complex) | Asserted source context - provenance only URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/submission-context | |||||
![]() ![]() ![]() |
C | 0..1 | (Complex) | Populated by the API on Application Enquiry. SHALL NOT be sent on submission. URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/application-status Constraints: sa-appstatus-1 | ||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..1 | Identifier | Application Number - populated by the API, absent on submission | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/application-number (no extensions allowed) | |||||
![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |||||
![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active (extensions allowed) | |||||
![]() ![]() |
1..1 | CodeableConcept | Category or discipline Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. Required Pattern: | |||||
![]() ![]() |
1..1 | code | claim | preauthorization | predetermination Binding: Use (required): The purpose of the Claim: predetermination, preauthorization, claim. Required Pattern: preauthorization (extensions allowed) | |||||
![]() ![]() |
1..1 | Reference(SA Patient) | The recipient of the products and services | |||||
![]() ![]() |
1..1 | dateTime | Resource creation date | |||||
![]() ![]() |
1..1 | Reference(SA Practitioner) | The Applicant - same Practitioner as QuestionnaireResponse.author | |||||
![]() ![]() |
1..1 | CodeableConcept | Desired processing ugency Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: stat, normal, deferred. Required Pattern: | |||||
![]() ![]() |
1..* | BackboneElement | Supporting information Slice: Unordered, Open by pattern:category Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Information instance identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Type of information Binding: ExceptionCodes (example): The valuset used for additional information codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | When it occurred | ||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
0..1 | Data to be provided | ||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Explanation for the information Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth. | |||||
![]() ![]() ![]() |
1..1 | BackboneElement | Supporting information | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Information instance identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of the supplied information Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes. Required Pattern: | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Type of information Binding: ExceptionCodes (example): The valuset used for additional information codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | When it occurred | ||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
1..1 | Reference(SA QuestionnaireResponse) | Data to be provided | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Explanation for the information Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth. | |||||
![]() ![]() |
1..1 | BackboneElement | Mandatory in FHIR R4 - logical reference to the Pharmaceutical Schedule only | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Insurance instance identifier Required Pattern: 1 (extensions allowed) | |||||
![]() ![]() ![]() |
1..1 | boolean | Coverage to be used for adjudication Fixed Value: true (no extensions allowed) | |||||
![]() ![]() ![]() |
1..1 | Reference(Coverage) | Insurance information | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() ![]() |
1..1 | string | Text alternative for the resource Required Pattern: Pharmaceutical Schedule (extensions allowed) | |||||
![]() ![]() |
C | 0..* | BackboneElement | Requested pharmaceuticals - NPPA and panel approval Applications only Constraints: sa-claim-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | positiveInt | Item instance identifier | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system 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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | NZMT CTPP ID (preferred) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://nzmt.org.nz (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Pharmac Pharmacode | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | Count of products or services Constraints: sqty-1 | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Claim.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Claim.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Claim.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Claim.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
| Claim.type | Base | extensible | Claim Type Codes | 📍4.0.1 | FHIR Std. |
| Claim.use | Base | required | Use | 📍4.0.1 | FHIR Std. |
| Claim.priority | Base | example | Process Priority Codes | 📍4.0.1 | FHIR Std. |
| Claim.related.relationship | Base | example | Example Related Claim Relationship Codes | 📍4.0.1 | FHIR Std. |
| Claim.payee.type | Base | example | PayeeType | 📍4.0.1 | FHIR Std. |
| Claim.careTeam.role | Base | example | Claim Care Team Role Codes | 📍4.0.1 | FHIR Std. |
| Claim.careTeam.qualification | Base | example | Example Provider Qualification Codes | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo.category | Base | example | Claim Information Category Codes | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo.code | Base | example | Exception Codes | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo.reason | Base | example | Missing Tooth Reason Codes | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo:questionnaireResponse.category | Base | example | Claim Information Category Codes | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo:questionnaireResponse.code | Base | example | Exception Codes | 📍4.0.1 | FHIR Std. |
| Claim.supportingInfo:questionnaireResponse.reason | Base | example | Missing Tooth Reason Codes | 📍4.0.1 | FHIR Std. |
| Claim.diagnosis.diagnosis[x] | Base | example | ICD-10 Codes | 📍4.0.1 | FHIR Std. |
| Claim.diagnosis.type | Base | example | Example Diagnosis Type Codes | 📍4.0.1 | FHIR Std. |
| Claim.diagnosis.onAdmission | Base | example | Example Diagnosis on Admission Codes | 📍4.0.1 | FHIR Std. |
| Claim.diagnosis.packageCode | Base | example | Example Diagnosis Related Group Codes | 📍4.0.1 | FHIR Std. |
| Claim.procedure.type | Base | example | Example Procedure Type Codes | 📍4.0.1 | FHIR Std. |
| Claim.procedure.procedure[x] | Base | example | ICD-10 Procedure Codes | 📍4.0.1 | FHIR Std. |
| Claim.insurance.coverage.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Claim.accident.type | Base | extensible | ActIncidentCode | 📦3.0.0 | THO v7.4 |
| Claim.item.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.revenue | Base | example | Example Revenue Center Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.category | Base | example | Benefit Category Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.modifier | Base | example | Modifier type Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.programCode | Base | example | Example Program Reason Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.subDetail.revenue | Base | example | Example Revenue Center Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.subDetail.category | Base | example | Benefit Category Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.subDetail.productOrService | Base | example | USCLS Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.subDetail.modifier | Base | example | Modifier type Codes | 📍4.0.1 | FHIR Std. |
| Claim.item.detail.subDetail.programCode | Base | example | Example Program Reason Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| sa-claim-1 | error | Claim.item | A requested pharmaceutical SHALL be identified by a CTPP ID or a Pharmacode. |
productOrService.coding.where(system = 'http://nzmt.org.nz' or system = 'https://fhir-ig.digital.health.nz/special-authority/ns/pharmacode').exists()
|
This structure is derived from Claim
Summary
Mandatory: 4 elements(7 nested mandatory elements)
Must-Support: 16 elements
Fixed: 4 elements
Prohibited: 39 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron