Pharmaceutical Claims Data Mart (PHARMS) DATA MART - DATA ... · The Pharmaceutical Claims Data Mart (Pharms DM) is a data mart that supports the management of pharmaceutical subsidies

Pharmaceutical Claims Data Mart (PHARMS)

DATA MART - DATA DICTIONARY

Version 4.2 April 2017

Error! Unknown document property name. Data Dictionary Pharmaceutical Claims

Version 4.2 MoH 2 April 2017

Reproduction of material

The Ministry of Health (‘the Ministry’) permits the reproduction of material from this publication without prior notification, providing all the following conditions are met: the information must not be used for commercial gain, must not be distorted or changed, and the Ministry must be acknowledged as the source.

Disclaimer

The Ministry of Health gives no indemnity as to the correctness of the information or data supplied. The Ministry of Health shall not be liable for any loss or damage arising directly or indirectly from the supply of this publication.

All care has been taken in the preparation of this publication. The data presented was deemed to be accurate at the time of publication, but may be subject to change. It is advisable to check for updates to this publication on the Ministry’s web site at http://www.health.govt.nz

Publications

A complete list of the Ministry’s publications is available from the Ministry of Health, PO Box 5013, Wellington, or on the Ministry’s web site at http://www.health.govt.nz

Any enquiries about or comments on this publication should be directed to:

Analytical Services

Ministry of Health

PO Box 5013

Wellington

Phone: (04) 816 2893 Fax: (04) 816 2898

Email: [email protected]

Published by Ministry of Health

© 2017, Ministry of Health

http://www.health.govt.nz/

http://www.health.govt.nz/



Introduction

Objectives The objectives of the Ministry of Health (‘the Ministry’) Data Dictionaries are to:

• describe the information available within the National Collections

• promote uniformity, availability and consistency across the National Collections

• support the use of nationally agreed protocols and standards wherever possible

• promote national standard definitions and make them available to users.

It is hoped that the greater level of detail along with clear definitions of the business rules around each element will assist with providing and using the data.

Audiences The target audiences for Data Dictionaries are data providers, software developers, and data users.

Format All data element definitions in the Data Dictionaries are presented in a format based on the Australian Institute of Health and Welfare National Health Data Dictionary. This dictionary is based on the ISO/IEC Standard 11179 Specification and Standardization of Data Elements—the international standard for defining data elements issued by the International Organization for Standardization and the International Electrotechnical Commission.

The format is described in detail in the appendices of this dictionary.

Changes to dictionary format A more rigorous approach to recording changes in the data elements has been introduced in these dictionaries along with background material on the features of time-series data for each element.

In summary, the changes to the data dictionaries include:

• standardisation of the element names so that, for instance, a healthcare user’s NHI number is referred to as NHI number in all collections

• elements are listed alphabetically within each table, and the tables are organised alphabetically

• each table is described

• verification rules, historical information, and data quality information are included

• alternative names for the elements are listed

• information about how the data is collected is given

• related data, and references to source documents and source organisations are included

• an alphabetical index is included

• code tables are included with the element, or a reference given to the Ministry’s web site (for large or dynamic code tables).



Please note the following: This data dictionary makes references to organisations called HealthPAC and NZHIS. These organisations were disestablished in 2008 and were absorbed into the Ministry of Health. For ‘HealthPAC’ or ‘NZHIS’ read ‘Ministry of Health’



Table of Contents

Pharmaceutical Claims ............................................................................................................................. 9

COS Code Reference table .................................................................................................................... 10 Cost of Service code .......................................................................................................................... 11 Description ......................................................................................................................................... 12

Claimant table ......................................................................................................................................... 13 Claimant address 1 ............................................................................................................................ 14 Claimant address 2 ............................................................................................................................ 15 Claimant address 3 ............................................................................................................................ 16 Claimant name ................................................................................................................................... 17 Claimant number ................................................................................................................................ 18 Funding DHB code ............................................................................................................................. 19 Funding DHB name ............................................................................................................................ 20 Region ................................................................................................................................................ 21 Trading name ..................................................................................................................................... 22

Costing Flags table ................................................................................................................................. 23 CHF Endorsement Flag...................................................................................................................... 24 Cost, Brand, Source of supply (CBS) flag .......................................................................................... 25 Dispensing fee code ........................................................................................................................... 26 Non Social Security (NSS) flag .......................................................................................................... 27 Rural Area Flag .................................................................................................................................. 28

Dispensing Flags table ............................................................................................................................ 29 Child resistant container ..................................................................................................................... 30 Form type ........................................................................................................................................... 31 Order type .......................................................................................................................................... 32 Stat indicator ...................................................................................................................................... 33

Form Pack Subsidy table ........................................................................................................................ 34 Alternate ............................................................................................................................................. 35 Base units .......................................................................................................................................... 36 Brand code ......................................................................................................................................... 37 Brand name ........................................................................................................................................ 38 Change............................................................................................................................................... 39 Chemical ID ........................................................................................................................................ 40 Chemical name .................................................................................................................................. 41 Cost, Brand, Source of supply (CBS) ................................................................................................. 42 Distributor ........................................................................................................................................... 43 Effective date ..................................................................................................................................... 44 Expiry date ......................................................................................................................................... 45 Form pack business key..................................................................................................................... 46 Formulation ID .................................................................................................................................... 47 Formulation name .............................................................................................................................. 48 Manufacturer ...................................................................................................................................... 49 Multiple ............................................................................................................................................... 50 OP ...................................................................................................................................................... 51 Pharmacode ....................................................................................................................................... 52 Presentation ID .................................................................................................................................. 53 Price ................................................................................................................................................... 54 Product ID .......................................................................................................................................... 55 Quantity .............................................................................................................................................. 56 Specified ............................................................................................................................................ 57 Stamp ................................................................................................................................................. 58 Subsidy .............................................................................................................................................. 59 Therapeutic group ID ......................................................................................................................... 60 Therapeutic group level 1 ID .............................................................................................................. 61 Therapeutic group level 1 name ......................................................................................................... 62 Therapeutic group level 2 ID .............................................................................................................. 63 Therapeutic group level 2 name ......................................................................................................... 64 Therapeutic group level 3 ID .............................................................................................................. 65 Therapeutic group level 3 name ......................................................................................................... 66 Therapeutic group manager ID .......................................................................................................... 67 Weight ................................................................................................................................................ 68

PHA Claim Fact table .............................................................................................................................. 69



Adjustment amount ............................................................................................................................ 70 Adjustment amount ex GST ............................................................................................................... 71 Catnip batch number .......................................................................................................................... 72 Claim approved date .......................................................................................................................... 73 Claim date .......................................................................................................................................... 74 Claim value ........................................................................................................................................ 75 Claim value ex GST ........................................................................................................................... 76 Claimant number ................................................................................................................................ 77 DSS count .......................................................................................................................................... 78 Date Suffix .......................................................................................................................................... 79 File type .............................................................................................................................................. 80 Number PHA subsidy cards ............................................................................................................... 81 Payment due date .............................................................................................................................. 82

PHA Dispensing Adjustments Fact table ................................................................................................ 83 CHF Endorsement Flag...................................................................................................................... 84 Catnip batch number .......................................................................................................................... 85 Child resistant container ..................................................................................................................... 86 Claim Amount ..................................................................................................................................... 87 Claim date .......................................................................................................................................... 88 Claimant number ................................................................................................................................ 89 Component number ........................................................................................................................... 90 Cost of Service code .......................................................................................................................... 91 Cost, Brand, Source of supply (CBS) flag .......................................................................................... 92 Cost, Brand, Source of supply (CBS) unit price ................................................................................. 93 Daily dose .......................................................................................................................................... 94 Data type ............................................................................................................................................ 95 Date Suffix .......................................................................................................................................... 96 Date dispensed .................................................................................................................................. 97 Days supply ........................................................................................................................................ 98 Dispensing fee value .......................................................................................................................... 99 Dispensings prescribed .................................................................................................................... 100 Dose ................................................................................................................................................. 101 Encrypted HCU ID ............................................................................................................................ 102 Form number .................................................................................................................................... 103 Frequency ........................................................................................................................................ 104 HealthPAC Chemical ID ................................................................................................................... 105 HealthPAC Cost Ex Supplier ............................................................................................................ 106 HealthPAC Pack ID .......................................................................................................................... 107 HealthPAC Pack Size....................................................................................................................... 108 HealthPAC Presentation ID .............................................................................................................. 109 HealthPAC Product ID...................................................................................................................... 110 Item number ..................................................................................................................................... 111 Locum identifier ................................................................................................................................ 112 National adjustment ......................................................................................................................... 113 Non Social Security (NSS) flag ........................................................................................................ 114 PHA Subsidy Card Indicator ............................................................................................................. 115 Patient contribution .......................................................................................................................... 116 Patient flag ....................................................................................................................................... 117 Pharmacode ..................................................................................................................................... 118 Prescribed quantity .......................................................................................................................... 119 Prescription number ......................................................................................................................... 120 Purchase unit key ............................................................................................................................. 121 Quantity dispensed .......................................................................................................................... 122 Quantity prescribed .......................................................................................................................... 123 Quantity units ................................................................................................................................... 124 Reimbursement Cost........................................................................................................................ 125 Repeat sequence number ................................................................................................................ 126 Requirement number ....................................................................................................................... 127 Requirement suffix ........................................................................................................................... 128 Retail subsidy ................................................................................................................................... 129 Rounding .......................................................................................................................................... 130 Rural Area Flag ................................................................................................................................ 131 Southern patient contribution remainder .......................................................................................... 132 Special authority number.................................................................................................................. 133 Special authority type ....................................................................................................................... 134 Specialist identifier ........................................................................................................................... 135



Stat indicator .................................................................................................................................... 136 Subsidy ............................................................................................................................................ 137

PHA Dispensing Fact table ................................................................................................................... 138 Age at dispensing ............................................................................................................................. 139 CHF Endorsement Flag.................................................................................................................... 140 Catnip batch number ........................................................................................................................ 141 Child resistant container ................................................................................................................... 142 Claim Amount ................................................................................................................................... 143 Claim Amount ex GST...................................................................................................................... 144 Claim approved date ........................................................................................................................ 145 Claim date ........................................................................................................................................ 146 Claimant number .............................................................................................................................. 147 Community Service Card Holder ...................................................................................................... 148 Component number ......................................................................................................................... 149 Cost ex supplier ............................................................................................................................... 150 Cost of Service code ........................................................................................................................ 151 Cost, Brand, Source of supply (CBS) flag ........................................................................................ 152 Cost, Brand, Source of supply (CBS) unit price ............................................................................... 153 Cost, Brand, Source of supply (CBS) unit price ex GST .................................................................. 154 DSS count ........................................................................................................................................ 155 Daily dose ........................................................................................................................................ 156 Data source ...................................................................................................................................... 157 Date Suffix ........................................................................................................................................ 158 Date dispensed ................................................................................................................................ 159 Days supply ...................................................................................................................................... 160 Dim Requirement Key ...................................................................................................................... 161 Dispensing fee code ......................................................................................................................... 162 Dispensing fee value ........................................................................................................................ 163 Dispensing fee value exgst .............................................................................................................. 164 Dispensings prescribed .................................................................................................................... 165 Dose ................................................................................................................................................. 166 Encrypted NHI number ..................................................................................................................... 167 Form cost ......................................................................................................................................... 169 Form cost ex GST ............................................................................................................................ 170 Form number .................................................................................................................................... 171 Form pack business key................................................................................................................... 172 Form type ......................................................................................................................................... 173 Frequency ........................................................................................................................................ 174 HealthPAC Chemical ID ................................................................................................................... 175 HealthPAC Cost Ex Supplier ............................................................................................................ 176 HealthPAC Cost ex Supplier ex GST ............................................................................................... 177 HealthPAC Pack Size....................................................................................................................... 178 HealthPAC Presentation ID .............................................................................................................. 179 HealthPAC Product Pack ID ............................................................................................................. 180 High use card indicator..................................................................................................................... 181 Item number ..................................................................................................................................... 182 Locum identifier ................................................................................................................................ 183 National adjustment ......................................................................................................................... 184 National adjustment ex GST ............................................................................................................ 185 Non Social Security (NSS) flag ........................................................................................................ 186 Oncology specialty patient grouping ................................................................................................ 187 Order type ........................................................................................................................................ 188 PEC form number ............................................................................................................................ 189 PHA Subsidy Card Indicator ............................................................................................................. 190 Patient category ............................................................................................................................... 191 Patient contribution .......................................................................................................................... 192 Patient contribution ex GST ............................................................................................................. 193 Patient flag ....................................................................................................................................... 194 Payment authority ............................................................................................................................ 195 Pharmacode ..................................................................................................................................... 196 Pharms provider type ....................................................................................................................... 197 Prescription ID .................................................................................................................................. 198 Prescription number ......................................................................................................................... 199 Provider number ............................................................................................................................... 200 Provider type .................................................................................................................................... 201 Purchase unit key ............................................................................................................................. 202



Quantity dispensed .......................................................................................................................... 203 Quantity prescribed .......................................................................................................................... 204 Quantity units ................................................................................................................................... 205 Reimbursement Cost........................................................................................................................ 206 Reimbursement Cost ex GST .......................................................................................................... 207 Repeat sequence number ................................................................................................................ 208 Requirement number ....................................................................................................................... 209 Requirement suffix ........................................................................................................................... 210 Retail subsidy ................................................................................................................................... 211 Retail subsidy ex GST ...................................................................................................................... 212 Role type .......................................................................................................................................... 213 Rounding .......................................................................................................................................... 214 Rounding ex GST ............................................................................................................................. 215 Rural Area Flag ................................................................................................................................ 216 Southern patient contribution remainder .......................................................................................... 217 Southern patient contribution remainder ex GST ............................................................................. 218 Special authority number.................................................................................................................. 219 Special authority type ....................................................................................................................... 220 Stat indicator .................................................................................................................................... 221 Subsidy value ................................................................................................................................... 222 Subsidy value ex GST ...................................................................................................................... 223

Patient Flags table ................................................................................................................................ 224 Community Service Card Holder ...................................................................................................... 225 High use card indicator..................................................................................................................... 226 PHA Subsidy Card Indicator ............................................................................................................. 227 Patient category ............................................................................................................................... 228 Patient flag ....................................................................................................................................... 229

Requirement table ................................................................................................................................. 230 Base units ........................................................................................................................................ 231 Requirement item name ................................................................................................................... 232 Requirement number ....................................................................................................................... 233 Requirement suffix ........................................................................................................................... 234 Short description .............................................................................................................................. 235

Appendix A: Logical to Physical Table Mapping ................................................................................... 236

Appendix B: List of Shared Dimensions ................................................................................................ 237

Appendix C: List of Views ..................................................................................................................... 238

Appendix D: Code Table Index ............................................................................................................. 239

Appendix E: Data Dictionary Template ................................................................................................. 240

Appendix F: Logical Groups of Data Elements ..................................................................................... 242

Appendix G: PHARMS Data Mart model .............................................................................................. 243



Pharmaceutical Claims

The Pharmaceutical Claims Data Mart (Pharms DM) is a data mart that supports the management of pharmaceutical subsidies. It is jointly owned by the Ministry of Health and Pharmac.

Pharms contains claim and payment information from pharmacists for subsidised dispensings that have been processed by the General Transaction Processing System (GTPS).

Error! Unknown document property name. Data Dictionary COS Code Reference table


COS Code Reference table Table name dim_cos

Definition Reference for Cost of Service code, which replaces Claimant Type. This defines the role of the pharmacy or the contract under which the pharmacy is supplying the drug. Source: HealthPAC

Primary key dim_cos_key

Business key cos_code

Guide for use Defunct reference table. Definition changed from September 2001 and this reference table no longer applies. It is retained for historical reasons. The unique key should be Claimant and COS code, but Claimant is not held in the table.

Relational rules This dimension table is linked via its primary key dim_cos_key to the foreign key dim_cos_key in the fact_pha_dispensing table

Data content



Cost of Service code Definition Cost of Service code that replaces Claimant type. This defines the role

of the pharmacy, or the contract under which the pharmacy is supplying the drug.

Column name cos_code

Table name dim_cos

Data type char(5)

Other names

Context

Layout NNNNN

Data domain

Guide for use Provides a unique link to the COS Code Reference table for claims between 1 June 2000 and September 2001. However, the link between the COS code and the actual contract it refers to is not in the Pharmhouse and needs to be obtained from HealthPAC. From 1 June 2000 to September 2001, code numbers started at '99' plus the codes from the Cost Code table. When HealthPAC transitioned to GTPS, the COS code changed to be unique to each pharmacy (for example, could be retail, wholesale, special), so from September 2001 the reference table no longer applies and is out of date. Indicates under which payment Service Contract the claim is priced, and allows a single pharmaceutical to be claimed under the correct Service Contract when a pharmacy has more than one service for the single item. The COS Code Reference table is defunct. The definition changed from September 2001 and the reference table no longer applies. It is retained for historical reasons. The unique key should be Claimant and COS code, but Claimant is not held in the table.

Verification rules

Collection methods

Related data

Source document

Source organisation HealthPAC



Description Definition

Column name description

Table name dim_cos

Data type varchar2(30)

Other names

Context

Layout

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation

Error! Unknown document property name. Data Dictionary Claimant table


Claimant table Table name dim_claimant

Definition Reference table for claimant (pharmacy or other institution) who is eligible to claim a pharmaceutical subsidy from HealthPAC payment office. Source: HealthPAC NZHIS Geocodes

Primary key dim_claimant_key

Business key claimant_number

Guide for use Data updated monthly. Each record should represent a pharmacy. However, in some cases a pharmacy may have more than one Claimant number. This usually occurs if a pharmacy has more than one contract (eg, retails and wholesale contracts). The claimant address is geocoded and the record count is checked against control totals from HealthPAC. On rare occasions, the geographic DHB is not the funding DHB. Some pharmacies no longer exist but their data is retained for linking up old records. The description may include an indication that the pharmacy is no longer current.

Relational rules This dimension table is linked via its primary key dim_claimant_key to the foreign key dim_claimant_key in the fact_pha_claim and fact_pha_dispensing tables.

Data content



Claimant address 1 Definition The first line of the claimant's address.

Column name claimant_address1

Table name dim_claimant


Other names

Context

Layout Free text

Data domain

Guide for use May have been changed from the address supplied by HealthPAC, to achieve geocoding.

Verification rules

Collection methods

Related data

Source document

Source organisation



Claimant address 2 Definition The second line of the claimant's address.




Other names

Context

Layout Free text

Data domain


Verification rules

Collection methods

Related data

Source document

Source organisation



Claimant address 3 Definition The third line of the claimant's address.




Other names

Context

Layout Free text

Data domain


Verification rules

Collection methods

Related data

Source document

Source organisation



Claimant name Definition The claimant's full name or title.

Column name claimant_name



Other names

Context

Layout Free text

Data domain

Guide for use Usually the name of the pharmacy, not the pharmacist?s name. If the claimant is no longer in business, this may be indicated in this field.

Verification rules

Collection methods

Related data

Source document from HealthPAC claimant file

Source organisation



Claimant number Definition A number given by HealthPAC to a pharmacy or other institution

authorised by the Ministry of Health and the Pharmaceutical Society to claim benefits.

Column name claimant_number


Data type integer

Other names Payee number

Context

Layout NNNNNNNNNN

Data domain 1 to 9999999

Guide for use Claimant number identifies the Contract from which payment and processing rules will be sought. HealthPAC gives each claimant a 7 character Payee number, which is converted to a 4 character Claimant number on a one-to-one mapping. In the future, it is likely that the Payee number will be reported to this field. Used as one of the keys to match form to item. Catnip batch number, Claimant number and Claim date form a unique link to the Claim table. The Claim table contains some historical Claimant numbers.

Verification rules Must be a valid Claimant number in the Claimant table.

Collection methods

Related data

Source document from HealthPAC form and HealthPAC item

Source organisation



Funding DHB code Definition Represents the District Health Board responsible for funding the

services under the contract.

Column name funding_dhb_code



Other names

Context

Layout NNN

Data domain

Guide for use A three digit code identifying the DHB that funds this claimant's claims. The Funding DHB code is to be populated with leading zeros. 011 - Northland 021 - Waitemata 022 - Auckland 023 - Counties Manakau 031 - Waikato 042 - Lakes 047 - Bay of Plenty 051 - Tairawhiti 061 - Hawkes Bay 071 - Taranaki 081 - Midcentral 082 - Whanganui 091 - Capital and Coast 092 - Hutt 093 - Wairarapa 101 - Nelson Marlborough 111 - West Coast 121 - Canterbury 123 - South Canterbury 131 - Otago 141 - Southland MOH - Ministry of Health

Verification rules

Collection methods

Related data

Source document

Source organisation



Funding DHB name Definition The name of the DHB responsible for funding the services under this

contract.

Column name funding_dhb_name



Other names

Context

Layout Free text

Data domain

Guide for use

Verification rules

Collection methods

Related data funding_dhb_code

Source document

Source organisation



Region Definition Name of Regional Health Authority where the Claimant is located

Column name region



Other names

Context

Layout Free text

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Trading name Definition Claimant's trading name.

Column name trading_name



Other names

Context

Layout Free text

Data domain

Guide for use Usually the name of the pharmacy. If the pharmacy is no longer in business, this may be indicated in the name.

Verification rules

Collection methods

Related data

Source document from HealthPAC claimant file

Source organisation

Error! Unknown document property name. Data Dictionary Costing Flags table


Costing Flags table Table name dim_costing_flags

Definition The Costing Flags table is a matrix of costing flags for linking to the PHA Dispensing Fact table.

Primary key dim_costing_flags_key

Business key prescriber_flag, prescription_flag, dispensing_fee_code, cbs_flag, nss_flag

Guide for use Each record contains five flags, this table holds every combination used for these flags.

Relational rules This dimension table is linked via its primary key dim_costing_flags_key to the foreign key dim_costing_flags_key in the fact_pha_dispensing table

Data content



CHF Endorsement Flag Definition Flag to indicate that the prescription has congestive heart failure

endorsement.

Column name prescription_flag

Table name dim_costing_flags


Other names

Context

Layout A

Data domain Y item has congestive heart failure endorsement N or space item has not congestive heart failure endorsement

Guide for use From Claim approved date of April 2002.

Verification rules If empty, set to 'N'.

Collection methods

Related data

Source document

Source organisation



Cost, Brand, Source of supply (CBS) flag Definition Flag to indicate whether the item is Cost, Brand, Source of supply

(CBS) as per the Pharmac schedule.

Column name cbs_flag



Other names

Context

Layout A

Data domain Y item is Cost, Brand, Source of supply (CBS) as per the Pharmac schedule N or space item is not Cost, Brand, Source of supply (CBS) as per the Pharmac schedule


Verification rules If empty, insert 'N'.

Collection methods

Related data

Source document

Source organisation



Dispensing fee code Definition Class of dispensing fee claimed.

Column name dispensing_fee_code


Data type integer

Other names

Context

Layout N

Data domain 0 to 9, null

Guide for use Has been supplied as null since Claim approved date of 1 August 1998. Retained for historical data.

Verification rules

Collection methods

Related data

Source document from HealthPAC item

Source organisation



Non Social Security (NSS) flag Definition Indicates whether the claim is a standard claim, credit transaction, non-

claim item or a resubmission of a previous claim.

Column name nss_flag



Other names

Context

Layout A

Data domain

Guide for use Equivalent of the HP variable transaction category. 'O' is part of the pharmaceutical electronic claiming process. Credit line transactions are used to credit a previously submitted claim transaction. These may either be used independantly, to credit a previous transaction claimed, or as part of a resubmission. Credit line transactions need only contain the following data elements in the Transaction Record of a claim file. Transactions may be resubmitted if the transaction field contents have changed. Only items that have been submitted with incorrect data should be resubmitted. Items that have been rejected by the system do not need to be resubmitted through this procedure. If a transaction is resubmitted, the resubmission must be transferred as two transactions.Pre Claim approved date of 1 August 1998: Y Not Subsidised N Subsidised space Undefined Post Claim approved date of 1 August 1998: C Credit I Invoice N Not Subsidised O Balance owing R Resubmission

Verification rules

Collection methods

Related data


Source organisation



Rural Area Flag Definition Flag field to indicate when a Practitioner's Supply Order is for use in a

rural area.

Column name prescriber_flag



Other names

Context

Layout A

Data domain Y item is a Practitioner's Supply Order in a rural area N space item is not a Practitioner's Supply Order in a rural area



Collection methods

Related data

Source document

Source organisation

Error! Unknown document property name. Data Dictionary Dispensing Flags table


Dispensing Flags table Table name dim_dispensing_flags

Definition The Dispensing Flags table is a matrix of dispensing flags for linking to the PHA Dispensing Fact table.

Primary key dim_dispensing_flags_key

Business key order_type, child_resistant_container, stat_indicator, form_type

Guide for use Each record contains four dispensing flags, this table holds every combination used for these dispensing flags.

Relational rules This dimension table is linked via its primary key dim_dispensing_flags_key to the foreign key dim_dispensing_flags_key in the fact_pha_dispensing table

Data content



Child resistant container Definition Flag field to indicate the medication has a safety cap on the container.

Column name child_resistant_container

Table name dim_dispensing_flags


Other names

Context

Layout A

Data domain Y child resistant container fee claimed. N, X, or space child resistant container fee not claimed.

Guide for use The list of applicable medications is in the Pharmac Schedule. The Child resistant container has not been populated since 2003.

Verification rules

Collection methods

Related data


Source organisation



Form type Definition The type of the prescription form for claims.

Column name form_type


Data type integer

Other names

Context

Layout NN

Data domain

Guide for use Order type should be used instead as HealthPAC derives the Form type from the Order type 1 Pharmacy prescription 2 Practitioner's supply order 3 Controlled drug 4 Controlled practitioner's supply order 5 Hospital prescription 6 Wholesales supply order 7 Bulk supply order 8 Controlled bulk supply order 9 Allergy treatment set 0 10 11 12 Invalid codes assume 1

Verification rules

Collection methods

Related data

Source document from HealthPAC form

Source organisation



Order type Definition Indicates the type of prescription or order.

Column name order_type


Data type integer

Other names

Context

Layout N

Data domain 1 Prescription 3 Practitioner's supply order (MPSO) 4 Bulk supply order (BSO) 5 Wholesale supply order (WSO) 6 Nicotene replacement therapy (NRT) 7 Oncology Medicines

Guide for use From Claim approved date of April 2002. Since electronic claiming used to work out the Form Type.

Verification rules

Collection methods

Related data

Source document

Source organisation



Stat indicator Definition Whether or not more than 30 days of the prescribed medication can be

given to the patient at one time.

Column name stat_indicator



Other names

Context

Layout A

Data domain Y extended supply N or space not extended supply

Guide for use Access exemption criteria (described in the Pharmac schedule) have to be met.

Verification rules

Collection methods

Related data


Source organisation

Error! Unknown document property name. Data Dictionary Form Pack Subsidy table


Form Pack Subsidy table Table name dim_form_pack_subsidy

Definition This table maintains hierarchical relationships between chemical, therapeutic group, formulation,brand, pack (pharmacode), and subsidies

Primary key dim_form_pack_subsidy_key

Business key form_pack_bk

Guide for use Data updated monthly

Relational rules This dimension table is linked via its primary key dim_form_pack_subsidy_key to the foreign key dim_form_pack_subsidy_key in the fact_pha_dispensing table.

Data content



Alternate Definition A higher subsidy value sometimes available on special authority.

Column name alternate

Table name dim_form_pack_subsidy

Data type number(10,2)

Other names

Context

Layout NNNNNNNN.NN

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Base units Definition The unit of measure for dispensing and measuring dose (PEC

specifications 2.29 'unit dispensed' and 'unit claimed').

Column name base_units



Other names Units of measure

Context

Layout Free text

Data domain

Guide for use Examples include tablets, pills, capsules, milligrams. Should agree with the NZ Pharmacy Guild's Generic unit of measure. With the move from Pronet to the GTPS system, units of measure of numerous drugs have been changed. For example, instead of one inhaler being prescribed (which has 200 doses) there are now 200 doses of the inhaler prescribed.

Verification rules

Collection methods

Related data

Source document

Source organisation



Brand code Definition Pharmac identifier for each product.

Column name brand_code


Data type integer

Other names

Context

Layout NNNNNNNN

Data domain 00000000 to 99999999

Guide for use 4-digit Chemical Code plus 2-digit Presentation ID (also known as Formulation Suffix) and 2-digit Brand Suffix.

Verification rules

Collection methods

Related data

Source document

Source organisation



Brand name Definition The trade name of the product given by the manufacturer.

Column name brand_name



Other names

Context

Layout Free text

Data domain

Guide for use Should match the Medsafe registered name for registered medicines.

Verification rules

Collection methods

Related data

Source document

Source organisation



Change Definition Indicates record type e.g. New Listing, Subsidy Change or Delisting etc.

Column name change



Other names

Context

Layout Free Text

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Chemical ID Definition Pharmac identifier of primary active chemical ingredient.

Column name chemical_id


Data type integer

Other names

Context

Layout NNNN


Guide for use If Chemical ID does not exist then the HPAC Chemical ID is used if it is present. All historical data was remapped in October 2000. Chemical ID and Presentation ID combine to form Formulation ID. The Chemical Reference table is created by Pharmac from their SiMPle database for Pharmhs. It is updated monthly, before the Dispensings load process runs.

Verification rules Set to zero if the Pharmacode has a bad check digit.

Collection methods

Related data Formulation ID

Source document

Source organisation Pharmac



Chemical name Definition Chemical (generic) name of the active chemical ingredient.

Column name chemical_name



Other names

Context

Layout Free text

Data domain

Guide for use Combined names exist for formulations with multiple active ingredients.

Verification rules

Collection methods

Related data

Source document

Source organisation



Cost, Brand, Source of supply (CBS) Definition Flag to indicate whether the item is Cost, Brand, Source of supply


Column name cbs



Other names

Context 'Cost Brand Source' - no price currently available for this pack; to be supplied bu the claimant.

Layout A




Collection methods

Related data

Source document

Source organisation



Distributor Definition Pharmac identifier for a pharmaceutical supply company.

Column name distributor


Data type integer

Other names

Context

Layout NNN


Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Effective date Definition The date this record becomes effective.

Column name effective


Data type date

Other names

Context

Layout Oracle datetime field

Data domain Valid dates

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Expiry date Definition The date this record expires.

Column name expiry


Data type date

Other names

Context



Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Form pack business key Definition The form_pack_bk is generated to provide a business key to

form/pack/subsidy relationships. This allows a link between the Form Pack Subsidy table and the Dispensing table.

Column name form_pack_bk



Other names

Context

Layout Free text

Data domain

Guide for use If there is a Pharmacode present the Form Pack BK will be prefixed by with the character P, if not the Form Pack BK will be prefixed with the character F.

Verification rules NZHIS datamart generated object.

Collection methods

Related data

Source document

Source organisation



Formulation ID Definition Pharmac Identifier for each Formulation classification of a drug.

Column name formulation_id


Data type integer

Other names

Context

Layout NNNNNN


Guide for use Comprises 4 digit Chemical ID and a 2 digit Presentation ID (also known as Formulation Suffix).

Verification rules

Collection methods

Related data Chemical ID Presentation ID

Source document

Source organisation



Formulation name Definition The name of the formulation that usually describes the form and

strength. Can also include the flavour or quality reference such as 'BP', but should not include Chemical, Brand or Pack attributes.

Column name formulation_name



Other names

Context

Layout Free text

Data domain

Guide for use A combination of the Chemical name and the Presentation name, for example, 'aspirin tablets'.

Verification rules

Collection methods

Related data

Source document

Source organisation



Manufacturer Definition Pharmac identifier for a pharmaceutical manufacturing company.

Column name manufacturer


Data type integer

Other names

Context

Layout NNN


Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Multiple Definition The smallest quantity that can be dispensed expressed in

[Formulation].[ Units]

Column name multiple



Other names

Context

Layout NNNNNNNNNNN.NN

Data domain 0.00 to 99999999.99

Guide for use

Verification rules Null OK

Collection methods

Related data

Source document

Source organisation



OP Definition 'Original Pack' - this drug must be dispensed in whole packs.

Column name op



Other names

Context

Layout N

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Pharmacode Definition NZ Pharmacy Guild identifier of retail pack indicating the

pharmaceutical dispensed.

Column name pharmacode


Data type integer

Other names Claim code

Context

Layout NNNNNNN


Guide for use HealthPAC sends the 13 digit bar code and NZHIS loads only the 6 or 7 digit portion relating to the drug. A 6 or 7 digit integer with a mod 11 check-digit. First supplied by HealthPAC from Claim approved date 17 December 1998. Expanded from 6 digits to 7 digits Claim approved date 1 October 2000.

Verification rules If not PCODE and not 'S' (and not CMPND unless value is '0000000000000') set to empty. The 'Pharmacode' currently administered by the Pharmacy Guild of New Zealand is currently the only valid code to be used.

Collection methods

Related data

Source document

Source organisation



Presentation ID Definition Pharmac identifier of presentation. Part of formulation for a chemical.

Column name presentation_id


Data type integer

Other names Formulation suffix

Context

Layout NN

Data domain 0 to 99

Guide for use Part of the chemical formulation equation, which describes the form and strength of the chemical. Mapped from Process Mapping table. If mapping does not exist then the HBL Presentation ID is used when it exists. All historical data remapped in October 2000. Part of the major key for the Dispensings table.

Verification rules Set to zero if the check digit is bad. Look up in Process Mapping and, if not found and CMPND or MCODE, use HBL presentation ID if a combination of Chemical ID and Presentation ID exists in the Augmented Formulation table.

Collection methods

Related data

Source document

Source organisation



Price Definition The supplier price for this pack.

Column name price



Other names

Context

Layout NNNNNNNN.NN

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Product ID Definition Pharmac identifier for a product (the brand suffix of a pharmaceutical).

Column name product_id


Data type integer

Other names Brand code suffix

Context

Layout NN

Data domain 0 to 99

Guide for use This is always zero before 17 December 1998. The last two digits from Brand code from the Pharmac schedule.

Verification rules Set to zero if badcheckdigit, look up in Process_Mapping if PCODE or S if no code exists the use HBL_Product_ID if result is null set to zero.

Collection methods

Related data

Source document

Source organisation



Quantity Definition The quantity per market Pack expressed in [Formulation].[Units]

Column name quantity



Other names

Context


Data domain 0 to 1

Guide for use Often reported as '0'.

Verification rules If the provided value is '0', set to '1'. Else store as reported.

Collection methods

Related data

Source document

Source organisation



Specified Definition Identifies pack size for unit pricing and inclusion in the printed schedule.

Column name specified



Other names

Context

Layout A

Data domain Y include pack size in the printed schedule N exclude pack size in the printed schedule

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Stamp Definition Sequential number generated for every new record or edit to facilitate

change control.

Column name stamp



Other names

Context

Layout Free text

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Subsidy Definition Maximum amount that the government will pay contractors for a

pharmaceutical dispensed to a person eligible for benefits. It is different to the cost to the government of subsidising the pharmaceutical (Subsidy value).

Column name subsidy



Other names

Context

Layout nnnnnnnn.nn

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Therapeutic group ID Definition Pharmac identifier for each group of Anatomical, Therapeutic and

Chemical properties.

Column name tg_id


Data type integer

Other names

Context

Layout NNNNNN


Guide for use Used to be known as Therapeutic Group. This is the international pharmaceutical standard way of grouping drugs. Some drugs are in more than one group. Pharmac uses Therapeutic Groups for administration. Structured 5 or 6 digit integer comprising TG level 1 ID, TG level 2 ID and TG level 3 ID. (Made up of 2 digits for each level, with no leading zero on TG level 1.) The Therapeutic Group Reference table is created by Pharmac for Pharmhouse. It is updated monthly, before the Dispensings load process runs.

Verification rules

Collection methods

Related data TG level 1 ID TG level 2 ID TG level 3 ID

Source document

Source organisation Pharmac



Therapeutic group level 1 ID Definition Identifier for ATC 1st level - anatomical main group.

Column name tg_level1_id


Data type integer

Other names

Context Refer to Therapeutic Group ID for further details.

Layout NN

Data domain 0 to 99

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Therapeutic group level 1 name Definition Description for ATC 1st level - anatomical main group.

Column name tg_name1



Other names


Layout Free text

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Therapeutic group level 2 ID Definition Identifier for ATC 2nd level - therapeutic main group.



Data type integer

Other names


Layout NN

Data domain 0 to 99

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Therapeutic group level 2 name Definition Description for ATC 2nd level - therapeutic main group.




Other names


Layout Free text

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Therapeutic group level 3 ID Definition Identifier for ATC 3rd level - therapeutic/pharmacological subgroup.



Data type integer

Other names


Layout NN

Data domain 0 to 99

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Therapeutic group level 3 name Definition Description for ATC 3rd level - therapeutic/pharmacological subgroup.




Other names


Layout Free text

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Therapeutic group manager ID Definition Therapeutic Group Manager Identifier, ie, the person at Pharmac

responsible for that Therapeutic Group.

Column name tgm_id



Other names

Context

Layout Free text

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Weight Definition The amount of the active ingredient in the formulation.

Column name weight



Other names



Data domain 0.0000 to 99999999.9999

Guide for use NULL values indicate that the 30-day dispensing rule need not apply.

Verification rules

Collection methods

Related data

Source document

Source organisation

Error! Unknown document property name. Data Dictionary PHA Claim Fact table


PHA Claim Fact table Table name fact_pha_claim

Definition A claim for pharmaceutical subsidy against dispensings from HealthPAC's payments office.

Primary key

Business key claimant_number, claim_date, catnip_batch_number

Guide for use Data for the PHA Claim Fact table is updated on a monthly basis. This table contains 400,000 rows as at June 2006. There are 25,000 rows added per month. Limit the number of joins to speed up queries.

Relational rules The Fact table has several foreign keys to dimension and fact tables. These are: KEY LINKED TO dim_claim_pay_due_date_key fact_pha_dispensing dim_claim_date_key

Data content



Adjustment amount Definition Adjustments accruing to earlier claim(s) for this claimant.

Column name adjustment_amount

Table name fact_pha_claim


Other names

Context


Data domain -99999999999.99 to 99999999999.99

Guide for use Includes negative values. Before Claim approved date of August 1998 includes Agency fee, Other value, Safety net cards value and Collection rate adjustment.

Verification rules

Collection methods

Related data

Source document

Source organisation



Adjustment amount ex GST Definition Adjustments accruing to earlier claim(s) for this claimant. Exclusive of

GST.

Column name adjustment_amount_exgst



Other names

Context

Layout nnnnnnnn.nn

Data domain

Guide for use Includes negative values. Before Claim approved date of August 1998 includes Agency fee, Other value, Safety net cards value and Collection rate adjustment.

Verification rules

Collection methods

Related data

Source document

Source organisation



Catnip batch number Definition A unique number for a batch of claims for a given claimant on a given

claim date.

Column name catnip_batch_number



Other names

Context

Layout

Data domain

Guide for use From Claim approved date of 1 July 2000, Catnip batch number is used as one of the keys to match form and item. Before that only Claimant, Claim date and Form number were required. Catnip batch number, Claimant number and Claim date form a unique link to the Claim table.

Verification rules

Collection methods

Related data

Source document

Source organisation



Claim approved date Definition Date HealthPAC approved the claim for payment.

Column name claim_approved_date


Data type date

Other names

Context



Guide for use Also the date on which HealthPAC extract data and NZHIS load it into the Pharmhouse. Each load of data to the Dispensings table is for a complete month of Claim approved date. It is the most important field when it comes to loading. Derived using the key Claimant number, Claim date and Catnip batch number. Dates range from 1 July 1996.

Verification rules Look up in Claim table using Claimant number, Claim date and Catnip batch number. Print warning if date invalid.

Collection methods

Related data Claim approved date month Claim approved date year Claimant number Claim date Catnip batch number

Source document from HealthPAC Claim

Source organisation



Claim date Definition End date of claim period given by payments office of HealthPAC.

Usually the 15th or the last day of the month.

Column name claim_date


Data type date

Other names

Context



Guide for use Used as one of the keys to match form to item. Dates range from 15 March 1996. Catnip batch number, Claimant number and Claim date form a unique link to the Claim table.

Verification rules

Collection methods

Related data Claim date month Claim date year

Source document from HealthPAC item and form

Source organisation



Claim value Definition Total value of the claim not including adjustments.

Column name claim_value



Other names

Context


Data domain 0.00 to 99999999999.99

Guide for use Each pharmacy makes a claim twice a month, so this is a useful high level grouping.

Verification rules

Collection methods

Related data

Source document

Source organisation



Claim value ex GST Definition Total value of the claim not including adjustments. Exclusive of GST.

Column name claim_value_exgst



Other names

Context

Layout nnnnnnnn.nn

Data domain

Guide for use Each pharmacy makes a claim twice a month, so this is a useful high level grouping.

Verification rules

Collection methods

Related data

Source document

Source organisation







Data type integer


Context

Layout NNNNNNNNNN




Collection methods

Related data


Source organisation



DSS count Definition

Column name dss_count


Data type integer

Other names

Context

Layout

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Date Suffix Definition This is the date suffix of the extract files supplied by the external

provider.

Column name date_suffix



Other names

Context

Layout YYMMDDA

Data domain

Guide for use Format is: YYMMDDA Used to identify when records were loaded to the data mart. It contains the month and year the load file was extracted from the systems at HealthPAC. For records migrated from Sybase to Oracle in 2006, the letter 'M' is appended and the dispensing month and year was used to populate this field.

Verification rules

Collection methods

Related data

Source document

Source organisation



File type Definition The source HealthPAC system.

Column name file_type



Other names

Context

Layout NNNNN

Data domain

Guide for use Made up of how the claim is processed and the version and release of the data specification. For example, '19300' is made up of 19 which relates to pharmacy processing and 300 which is the Version and Release of this data specification. Identifies whether the claim is manual, or the version of the electronic claim. Some manual claims are still made. 90 percent of claims are made in PEC (Pharmaceutical Electronic Claiming). Data supplied since Claim approved date of 1 October 2000. 19228 PEC Version 2.28 19229 PEC Version 2.29 19300 PEC Version 3.00 19529 Pronet (previously known as GTPS) 19530 WinCAPP (Manual Data Capture Application) 20510 (Early pharmacy specification) 39001 Manual Claiming 39150 Electronic Version 1.5 (transition from manual to electronic) Uses the key Claimant number, Claim date and Catnip batch number.

Verification rules

Collection methods

Related data

Source document from HealthPAC Claim file

Source organisation



Number PHA subsidy cards Definition Number of Pharmaceutical Subsidy Cards issued.

Column name number_pha_subsidy_cards


Data type integer

Other names

Context

Layout NNNNNNNN


Guide for use Number of Pharmaceutical Subsidy Cards issued by the claimant over the period of this claim.

Verification rules

Collection methods

Related data

Source document

Source organisation



Payment due date Definition Date the payment is due to be made to the pharmacy by HealthPAC.

Column name payment_due_date


Data type date

Other names

Context



Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation

Error! Unknown document property name. Data Dictionary PHA Dispensing Adjustments Fact table


PHA Dispensing Adjustments Fact table Table name fact_pha_disp_adjustments

Definition Table to hold the Itex records. Source: HealthPAC

Primary key

Business key

Guide for use This table holds all credits and resubmissions of the Items (dispensings). These have never been applied to the Dispensings table. Itex records have been supplied by HealthPAC from April 2000 and represent a NSS Flag value of C for credits and R for Resubmissions.

Relational rules None

Data content




endorsement.


Table name fact_pha_disp_adjustments


Other names

Context

Layout A




Collection methods

Related data

Source document

Source organisation




claim date.




Other names

Context

Layout

Data domain


Verification rules

Collection methods

Related data

Source document

Source organisation







Other names

Context

Layout A



Verification rules

Collection methods

Related data


Source organisation



Claim Amount Definition For electronic claims since August 1998, this field is what was claimed

by the pharmacy as payment for this item, ie, the subsidy amount.

Column name claim_amount



Other names

Context

Layout 99999999.99

Data domain

Guide for use Includes the payment to be made by the DHB for the pharmaceutical, all fees and GST. Excludes patient co-payment. Where the item is compounded, only the first item should contain the subsidy amount. Subsidy amount = Pharmaceutical subsidy + Mark-ups + GST + Dispensing fee - Patient contribution Mark-ups, and Dispensing fees may differ by each pharmacy contract. Before August 1998 this field held the patient charge carried over to second or later repeats, if any. Now inaccurately named. There have been no container fees since 2003.

Verification rules

Collection methods

Related data


Source organisation







Data type date

Other names

Context




Verification rules

Collection methods



Source organisation







Data type integer


Context

Layout NNNNNNNNNN




Collection methods

Related data


Source organisation



Component number Definition A sequential number indicating the components that make up a

dispensing, for example, component '1' is line one of a group of transactions, component '2' is line two, etc.

Column name component_number


Data type integer

Other names

Context Mixture or compound components.

Layout NN

Data domain 0 to 99 Pre Claim approved date of 10 August 1998: 0: not a mixture 1: aggregate of a mixture 2+: mixture component Post Claim approved date of 10 August 1998: 0: For all items (including aggregate of compound). 1+: compound components

Guide for use Before Claim approved date of 10 August 1998, the first record of a dispensing would have a Component number of '0' if not a mixture or '1' if a mixture (ie, first record would contain aggregate of dispensing). Subsequent records would be sent for each component in the aggregate (if a mixture), and a sequential Component number given for each record. After Claim approved date of 10 August 1998, compounds are identified by Data source 'C'. Reimbursement cost, dispensing fee, patient co-pay and mark-ups only included on aggregate compound record (with Component number of '0'). When extracting data, use either records with '0' or the aggregate of records with '1' to 'X'. Part of the major key of the Dispensings table. The first line transaction of a compound (Compound number '0') includes all the data fields required for a line transaction, including the quantity amount for the compound. Subsequent line transactions of a compound (Compound numbers '1', '2', etc) only supply the data required for that component.

Verification rules

Collection methods

Related data


Source organisation








Other names

Context

Layout NNNNN

Data domain


Verification rules

Collection methods

Related data

Source document









Other names

Context

Layout A




Collection methods

Related data

Source document

Source organisation



Cost, Brand, Source of supply (CBS) unit price Definition The item is eligible for subsidy on the pharmacy's annotated purchase

price, brand and source of supply.

Column name cbs_unit_price



Other names

Context

Layout $$$$$$$$.$$

Data domain 0.00 to 99999999.99

Guide for use There is no set manufacturer's price and it will be subsidised at the price at which it is obtained by the pharmacy as long as it is flagged CBS in the schedule.

Verification rules

Collection methods

Related data

Source document

Source organisation



Daily dose Definition The amount of base units prescribed to be used per day in the dose unit

of measure defined by Pharmac.

Column name daily_dose



Other names

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99

Guide for use Supplied from HealthPAC item since Claim approved date of 1 May 2000. From June 2001 missing data mapped by multiplying dose by frequency if they exist. Not always an integer because, if not provided, the value is derived. If the Daily dose is unable to be expressed (eg, 'Take as needed'), this field should be set to '0'. If the field is set to '0', the Dose flag should be set to 'Y'. If the number of units is a range, the higher amount is used. If it is greater than zero insert value, else if Dose and Frequency > 0 then Daily_Dose = Dose x Frequency. If the units are spread over alternate days, eg, every other day, or Monday, Wednesday and Friday, the value should represent this: For example, one unit every other day will equate to 0.5 of a unit. For example, Monday, Wednesday, and Friday will equate to 0.4285. As this field requires data expressed to 4 decimal places with no decimal points, 0.5 of a unit would appear in the data file as 5000, and 0.4285 would appear as 4285.

Verification rules

Collection methods

Related data Frequency Quantity Days Supply Dose


Source organisation



Data type Definition

Column name data_type



Other names

Context

Layout

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation




provider.




Other names

Context

Layout YYMMDDA

Data domain


Verification rules

Collection methods

Related data

Source document

Source organisation



Date dispensed Definition The date the medication was given to the patient.

Column name date_dispensed


Data type date

Other names

Context



Guide for use Fully populated since 10 August 1998.

Verification rules

Collection methods

Related data Date dispensed month Date dispensed year


Source organisation



Days supply Definition The number of days? medication the patient has been supplied with at

this time.

Column name days_supply


Data type number(6)

Other names

Context

Layout NNNNNN


Guide for use Calculated by the HealthPAC claim payment process. Often values missing.

Verification rules

Collection methods

Related data Daily dose


Source organisation



Dispensing fee value Definition Fee paid to the claimant for dispensing the medication to the patient.

Column name dispensing_fee_value



Other names Professional fee

Context Cost

Layout $$$$$$$$.$$

Data domain 0.00 to 99999999.99

Guide for use One of the variables that go into the Cost breakdown. Includes GST.

Verification rules If empty, set to '0'.

Collection methods

Related data


Source organisation



Dispensings prescribed Definition Number of repeats on a prescription, including the first dispensing.

Column name dispensings_prescribed


Data type integer

Other names

Context

Layout NN

Data domain 0 to 99

Guide for use Used for determining number of dispensings prescribed, as opposed to number used. Unlimited repeats are indicated as 99.

Verification rules

Collection methods

Related data


Source organisation



Dose Definition The number of units prescribed to be used at each use of the

medication measured in Quantity units, for example 1 tablet.

Column name dose



Other names

Context

Layout NNNNN.NN

Data domain 0.00 to 99999.99

Guide for use Converted by HealthPAC from a NNNNNN.NNNN format to a NNN.NN format. If the Dose is unable to be expressed (eg, 'Take as needed'), this field should be set to '0'. If the number of units is a range, the higher amount is used. Dose x Frequency = Daily dose

Verification rules

Collection methods



Source organisation



Encrypted HCU ID Definition The NHI number in encrypted format.

Column name encrypted_hcu_id



Other names

Context

Layout 3 alphabetic characters plus 4 numerics the last of which is a check digit, and then encrypted into a 11 character string

Data domain System-generated

Guide for use Stored in the warehouse encrypted. Data from Claim approved date of April 2002. Coverage is approximately 30 percent. A Pharmacy Contract with a target of 90% coverage will shortly be in place. See the NZHIS release policy. The NHI number is the cornerstone of NZHIS's data collections. It is a unique 7-character identification number assigned to a healthcare user by the National Health Index (NHI) database. The NHI number uniquely identifies healthcare users, and allows linking between different data collections. It is encrypted in the Pharmhouse to ensure privacy of individual records.

Verification rules Must be a valid code

Collection methods Sourced from NHI.

Related data

Source document http://www.health.govt.nz/our-work/health-identity/national-health-index for more information on the NHI number

Source organisation NZHIS



Form number Definition Identifier for each prescription item.

Column name form_number


Data type integer

Other names

Context

Layout NNNNN


Guide for use Used as one of the keys to match form and item. Recommend this is used in conjunction with date or claimant, depending on the level of aggregation. For some pharmacies this is not a unique number.

Verification rules

Collection methods

Related data

Source document from HealthPAC form and item

Source organisation



Frequency Definition How often the medication is supposed to be taken.

Column name frequency



Other names

Context

Layout NNNN.NN


Guide for use If not present, then it is derived by calculating Daily Dose divided by Dose (if they exist), unless the result is too large to fit in the field.

Verification rules A zero or value greater than 99.99 is converted to a null.

Collection methods


Source document For manual claims from HealthPAC item

Source organisation



HealthPAC Chemical ID Definition Stat identifier of primary active chemical ingredient.

Column name hpac_chemical_id


Data type number(5)

Other names

Context

Layout NNNNN

Data domain 1000 to 9999 or '0' if no HPAC Chemical ID

Guide for use Assigned by HealthPAC since Claim approved date of 3 August 1998.

Verification rules If empty and not CMPND then default to '0' and print warning.

Collection methods

Related data


Source organisation



HealthPAC Cost Ex Supplier Definition Total cost of medication in the schedule, which includes GST.

Column name hpac_cost_ex_supplier_incl



Other names

Context

Layout $$$$$$.$$$$

Data domain -999999.9999 to 999999.9999

Guide for use Supplied by HealthPAC since Claim approved date of 3 August 1998.

Verification rules If empty set to '0'.

Collection methods

Related data


Source organisation



HealthPAC Pack ID Definition The HPAC Pack ID

Column name hpac_pack_id


Data type number(5)

Other names

Context

Layout NNNNN

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



HealthPAC Pack Size Definition Quantity (of base quantities) in a pack.

Column name hpac_pack_size



Other names

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99


Verification rules

Collection methods

Related data


Source organisation



HealthPAC Presentation ID Definition Pharmac identifier of presentation, now known as formulation for a

chemical.

Column name hpac_presentation_id


Data type integer

Other names

Context

Layout NN

Data domain 0 to 99


Verification rules If empty and not a CMPND, set to '0' and print a warning.

Collection methods

Related data


Source organisation



HealthPAC Product ID Definition The healthpac unique id for the product.

Column name hpac_product_id


Data type integer

Other names

Context

Layout

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Item number Definition Sequential identifier of an item within a prescription form.

Column name item_number


Data type integer

Other names

Context

Layout NN

Data domain 0 to 99

Guide for use Number of items per form, not including repeats. Part of the major key for the Dispensings table.

Verification rules

Collection methods

Related data


Source organisation



Locum identifier Definition The registration number of the healthcare provider if the provider was a

locum (from Medical Council, NZ Dental Association, etc).

Column name locum_id


Data type integer

Other names

Context

Layout NNNNNNNNNN


Guide for use From Claim approved date of April 2002. Usually temporary Doctor number. Usually reported as 6 digits.

Verification rules

Collection methods

Related data

Source document

Source organisation



National adjustment Definition

Column name national_adjustment



Other names

Context

Layout NNN.NNNN

Data domain 000.0000 to 999.9999

Guide for use From Claim approved date of May 2002. No longer used from 2003. The Triple and Southern pharmacy contracts have clauses which attempt to provide consistent charges to patients regardless of geography (and the contract a particular pharmacy will be paid under). Where payment for an item is less than the patient co-payment, then the National Consistency formula applies. If subsequently, a repeat claim is made (for example) which results in the total cost of all the supplies of the medicine (plus professional fee) being above the patient co-payment, the payment for the initial item must be recalculated under applicable contract. This recalculation (at the higher contract rate) often results in a 'wash-up' value owed on the initial supply (and paid on the repeat), and the national adjustment figure is the 'wash-up' value.


Collection methods

Related data

Source document

Source organisation








Other names

Context

Layout A

Data domain

Guide for use Equivalent of the HP variable transaction category. 'O' is part of the pharmaceutical electronic claiming process. Credit line transactions are used to credit a previously submitted claim transaction. These may either be used independantly, to credit a previous transaction claimed, or as part of a resubmission. Credit line transactions need only contain the following data elements in the Transaction Record of a claim file. Transactions may be resubmitted if the transaction field contents have changed. Only items that have been submitted with incorrect data should be resubmitted. Items that have been rejected by the system do not need to be resubmitted through this procedure. If a transaction is resubmitted, the resubmission must be transferred as two transactions. Pre Claim approved date of 1 August 1998: Y Not Subsidised N Subsidised space Undefined Post Claim approved date of 1 August 1998: C Credit I Invoice N Not Subsidised O Balance owing R Resubmission

Verification rules

Collection methods

Related data


Source organisation



PHA Subsidy Card Indicator Definition Indicates whether person has a PHA subsidy card or not at the time of

the initial dispensing. If the person is entitled to a subsidy card for some items on a prescription form, only these items are classified as having a PHA subsidy card.

Column name pha_subsidy_card_ind



Other names

Context Patient information

Layout A

Data domain Y patient has a Pharmaceutical Subsidy Card N, space, other values patient does not have a Pharmaceutical Subsidy Card

Guide for use

Verification rules

Collection methods

Related data


Source organisation



Patient contribution Definition The amount the patient has to pay for the medication (GST Inclusive).

Column name patient_contribution



Other names

Context

Layout $$$$$$$$.$$

Data domain 0.00 to 99999999.99

Guide for use Based on the patient category, Income Group, HUHC, Prescription Subsidy Card (abatement amount). Supplied by HealthPAC from Claim approved date of 3 January 1996.


Collection methods

Related data


Source organisation



Patient flag Definition To specify Diane35 Pharmacode X where used as an oral

contraception.

Column name patient_flag



Other names

Context

Layout A

Data domain Y item is a Diane35 Pharmacode X where used as an oral contraception. N space item is not a Diane35 Pharmacode X where used as an oral contraception.



Collection methods

Related data

Source document

Source organisation







Data type integer


Context

Layout NNNNNNN




Collection methods

Related data

Source document

Source organisation



Prescribed quantity Definition The quantity of medication claimed.

Column name prescribed_quantity



Other names

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Prescription number Definition Number given to each item by the pharmacy's system.

Column name prescription_number


Data type integer

Other names

Context

Layout NNNNNNNNN


Guide for use Where a number of pharmaceutical items are combined or compounded, each item should have the same Prescription ID. Supplied from Claim approved date of 26 April 1996.

Verification rules

Collection methods

Related data


Source organisation



Purchase unit key Definition Generated artificial key for the dim_purchase_unit table

Column name dim_purchase_unit_key


Data type integer

Other names

Context

Layout

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Quantity dispensed Definition Total quantity of medication that was paid, including wastage.




Other names

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99

Guide for use Before 1 August 1998 it was total quantity of medication claimed for subsidy.


Collection methods



Source organisation



Quantity prescribed Definition The quantity of medication claimed.

Column name quantity_prescribed



Other names Quantity dispensed

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99

Guide for use This must be defined using the Quantity units relating to the Pharmacode as specified by Pharmac. Supplied by HealthPAC from Claim approved date of 3 August 1998.

Verification rules

Collection methods

Related data


Source organisation



Quantity units Definition Units in which quantity is measured for manual claims only.

Column name quantity_units



Other names

Context

Layout A

Data domain C Capsules G Grams I International units L Litres M or m Mixture T Tablets U Units X Unknown quantity units space 0 H Missing quantity units

Guide for use This is similar to Base units. However, if you want a unit of quantity, Base units is the recommended value.

Verification rules

Collection methods

Related data


Source organisation



Reimbursement Cost Definition Value reimbursed to the pharmacy, on this dispensing of a prescription

item that includes GST, and can be negative.

Column name reimbursement_cost



Other names Item price

Context

Layout $$$$$$$$.$$

Data domain -99999999.99 to 99999999.99

Guide for use One of the main reporting variables for expenditure. An invalid value such as null will be converted to zero. Can be negative depending on the contract.

Verification rules

Collection methods

Related data


Source organisation



Repeat sequence number Definition Sequential identifier of repeat dispensings for a prescription item.

Column name repeat_sequence_number


Data type integer

Other names

Context

Layout NN

Data domain 0 to 99

Guide for use Value in the range of 0 to 99 where 0 for a stat supply or single dispensing, or 1 for an initial repeat dispensing and 2+ for repeats.

Verification rules

Collection methods

Related data


Source organisation



Requirement number Definition First four digits of HealthPAC 6-digit Medicode that identifies chemicals.

Column name requirement_number


Data type number(5)

Other names

Context

Layout NNNNN


Guide for use This was only used for manual claims, and these are now by Pharmacode. Medicode is retained for historical purposes only.

Verification rules

Collection methods

Related data


Source organisation



Requirement suffix Definition For historical use only.

Last two digits of HealthPAC 6-digit Medicode, which identifies form and strength of a chemical for manual claims only.

Column name requirement_suffix


Data type integer

Other names

Context

Layout NN

Data domain 0 to 99

Guide for use

Verification rules

Collection methods

Related data


Source organisation



Retail subsidy Definition Total Schedule cost of medication plus mark-ups and GST.

Column name retail_subsidy



Other names

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99

Guide for use Supplied by HealthPAC from Claim approved date of 3 August 1998.


Collection methods

Related data


Source organisation



Rounding Definition This field is used to round the transaction item (once all fees have been

applied) to the nearest cent.

Column name rounding



Other names

Context

Layout .NNNN

Data domain .0000 to .9999

Guide for use Example: if the amount to be paid = 6.5107, this is rounded to the nearest cent. Hence the payment amount would be 6.51 and the rounding value would be -.0007. From Claim approved date of May 2002.


Collection methods

Related data

Source document

Source organisation




rural area.




Other names

Context

Layout A




Collection methods

Related data

Source document

Source organisation



Southern patient contribution remainder Definition Southern Patient Contribution remainder. The amount of money the

patient will have to pay on the next repeat.

Column name s_patient_cont_remainder



Other names

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99

Guide for use This field applies to all contracts that are double priced. The South Island has some special subsidy for dispensing. From Claim approved date of April 2002. Discontinued from 2003.


Collection methods

Related data

Source document

Source organisation



Special authority number Definition Special Authority Approval Number which is known as Section 99

Number.

Column name special_authority_number


Data type integer

Other names

Context

Layout NNNNNNN


Guide for use For drugs that are treated differently by Pharmac, where authority is required to dispense the drug. Paired with Special authority type.

Verification rules

Collection methods

Related data


Source organisation



Special authority type Definition Type of Special Authority.

Column name special_authority_type



Other names

Context

Layout AAAA

Data domain

Guide for use For drugs that are treated differently by Pharmac, where authority is required to dispense the drug. Paired with Special authority number. For Claim approved dates before May 2002, this field can be derived from the Special Authority Number. Refer to the Special Authority Reference table. The Special Authority Reference table has not been updated since September 2001, so between September 2001 and May 2002 the data is incomplete. From May 2002, data supplied in the Dispensings table by HealthPAC. CHEM Special Authority CHFA Exceptional Circumstances Central Health Funding Authority HOSP Special Authority MHFA Midland Health Funding Authority NHFA Exceptional Circumstances North Health Funding Authority RISK Special Authority SHFA Exceptional Circumstances South Health Funding Authority SPEC Special Authority TEMP Templeton UNKN Unknown

Verification rules

Collection methods

Related data

Source document




Specialist identifier Definition New Zealand Medical Council Number of specialist who recommended

the prescription, or a Ministry of Health number assigned to hospital staff who have written the prescription.

Column name specialist_id



Other names

Context

Layout XXXXXXXXXXX

Data domain 00000000000 to 99999999999 (can contain characters)

Guide for use From Claim approved date of July 2000. Links with Provider Code in the Provider Index table.

Verification rules Truncated to 11 characters and leading zeros added if required.

Collection methods

Related data

Source document

Source organisation








Other names

Context

Layout A



Verification rules

Collection methods

Related data


Source organisation



Subsidy Definition Maximum amount that the government will pay contractors for a

pharmaceutical dispensed to a person eligible for benefits. It is different to the cost to the government of subsidising the pharmaceutical (Subsidy value).

Column name subsidy_value



Other names

Context

Layout nnnnnnnn.nn

Data domain

Guide for use Now derived from Subsidy value (also known as base price used) divided by Quantity dispensed. Before 1 August 1998 renamed from Price Ex Supplier which was sourced from the Price History table.

Verification rules If Subsidy value or Quantity dispensed is empty or '0', set to null.

Collection methods

Related data Subsidy value Quantity dispensed

Source document

Source organisation

Error! Unknown document property name. Data Dictionary PHA Dispensing Fact table


PHA Dispensing Fact table Table name fact_pha_dispensing

Definition A dispensing of a drug formed by combining the HealthPAC Form and Item tables. Data is updated monthly and a record count and total cost are checked against the totals from HealthPAC. Source: HealthPAC

Primary key

Business key

Guide for use Queries on the PHA Dispensing Fact table should always be tightly constrained because the table contains at least 500 million rows. There are approximately 4-5 million rows for each month.

Relational rules The Fact table has severalforeign keys to dimension tables these are: KEY LINKED TO dim_health_care_user_key dim_health_care_user table dim_requirement_key dim_re

Data content



Age at dispensing Definition The age of the patient at the time of the dipensing of the prescription.

Calculated by the equation of the Date of Dispensing less the NHI date of birth.

Column name age_at_dispensing

Table name fact_pha_dispensing

Data type integer

Other names

Context

Layout NNN

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation




endorsement.




Other names

Context

Layout A




Collection methods

Related data

Source document

Source organisation




claim date.




Other names

Context

Layout

Data domain


Verification rules

Collection methods

Related data

Source document

Source organisation







Other names

Context

Layout A



Verification rules

Collection methods

Related data


Source organisation



Claim Amount Definition For electronic claims since August 1998, this field is what was claimed

by the pharmacy as payment for this item, ie, the subsidy amount.

Column name claim_amount



Other names

Context

Layout 99999999.99

Data domain

Guide for use Includes the payment to be made by the DHB for the pharmaceutical, all fees and GST. Excludes patient co-payment. Where the item is compounded, only the first item should contain the subsidy amount. Subsidy amount = Pharmaceutical subsidy + Mark-ups + GST + Dispensing fee - Patient contribution Mark-ups, and Dispensing fees may differ by each pharmacy contract. Before August 1998 this field held the patient charge carried over to second or later repeats, if any. Now inaccurately named. There have been no container fees since 2003.

Verification rules

Collection methods

Related data


Source organisation



Claim Amount ex GST Definition For electronic claims since August 1998, this field is what was claimed

by the pharmacy as payment for this item, ie, the subsidy amoun, less the GST component.

Column name claim_amount_exgst



Other names

Context

Layout nnnnnnnn.nn

Data domain

Guide for use Convers the payment to be made by the DHB for the pharmaceutical and all fees, Excludes the GST component. Excludes patient co-payment. Where the item is compounded, only the first item should contain the subsidy amount. Subsidy amount = Pharmaceutical subsidy + Mark-ups + Dispensing fee - Patient contribution Mark-ups, and Dispensing fees may differ by each pharmacy contract. Before August 1998 this field held the patient charge carried over to second or later repeats, if any. Now inaccurately named. There have been no container fees since 2003.

Verification rules

Collection methods

Related data


Source organisation



Claim approved date Definition Date HealthPAC approved the claim for payment.

Column name claim_approved_date


Data type date

Other names

Context



Guide for use Also the date on which HealthPAC extract data and NZHIS load it into the Pharmhouse. Each load of data to the Dispensings table is for a complete month of Claim approved date. It is the most important field when it comes to loading. Derived using the key Claimant number, Claim date and Catnip batch number. Dates range from 1 July 1996.

Verification rules Look up in Claim table using Claimant number, Claim date and Catnip batch number. Print warning if date invalid.

Collection methods

Related data Claim approved date month Claim approved date year Claimant number Claim date Catnip batch number

Source document from HealthPAC Claim

Source organisation







Data type date

Other names

Context




Verification rules

Collection methods



Source organisation







Data type integer


Context

Layout NNNNNNNNNN




Collection methods

Related data


Source organisation



Community Service Card Holder Definition Indicates whether patient is a Community Services Card holder at the

time of the initial dispensing.

Column name csc_ind


Data type integer

Other names

Context

Layout N

Data domain 1 CSC converted from Y 2 Code not used since 1 July 1993 3 No CSC converted from N 4 Low cost PHO enrollee null 0 8 Undefined

Guide for use Relates to HCU identifier at a particular point in time. Definition of PHO enrolee changes over time in accordance with the Public Health Strategy. '2' has been disabled.

Verification rules

Collection methods

Related data

Source document

Source organisation



Component number Definition A sequential number indicating the components that make up a

dispensing, for example, component '1' is line one of a group of transactions, component '2' is line two, etc.

Column name component_number


Data type integer

Other names

Context Mixture or compound components.

Layout NN

Data domain 0 to 99 Pre Claim approved date of 10 August 1998: 0: not a mixture 1: aggregate of a mixture 2+: mixture component Post Claim approved date of 10 August 1998: 0: For all items (including aggregate of compound). 1+: compound components

Guide for use Before Claim approved date of 10 August 1998, the first record of a dispensing would have a Component number of '0' if not a mixture or '1' if a mixture (ie, first record would contain aggregate of dispensing). Subsequent records would be sent for each component in the aggregate (if a mixture), and a sequential Component number given for each record. After Claim approved date of 10 August 1998, compounds are identified by Data source 'C'. Reimbursement cost, dispensing fee, patient co-pay and mark-ups only included on aggregate compound record (with Component number of '0'). When extracting data, use either records with '0' or the aggregate of records with '1' to 'X'. Part of the major key of the Dispensings table. The first line transaction of a compound (Compound number '0') includes all the data fields required for a line transaction, including the quantity amount for the compound.

Verification rules

Collection methods

Related data


Source organisation



Cost ex supplier Definition Total cost of medication in the schedule minus GST.

Column name cost_ex_supplier



Other names

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99

Guide for use It was manufacturer cost per pack from Price History. From 10 August 1998 Subsidy value divided by HBL Pack size multiplied by Quantity dispensed. If result is null or zero then HBL Cost Ex Supplier minus GST.

Verification rules Cost_Ex_Supplier = Subsidy_Value / HBL_Pack_Size x Quantity unless HBL_Pack_Size or Quantity is null or zero in which case Cost_Ex_Supplier = (HBL_Cost_Ex_Supplier_INCL / 1.125) or null if HBL_Cost_Ex_Supplier_INCL is null or zero. Defaults to null.

Collection methods

Related data

Source document

Source organisation








Other names

Context

Layout NNNNN

Data domain


Verification rules

Collection methods

Related data

Source document









Other names

Context

Layout A




Collection methods

Related data

Source document

Source organisation



Cost, Brand, Source of supply (CBS) unit price Definition The item is eligible for subsidy on the pharmacy's annotated purchase

price, brand and source of supply.

Column name cbs_unit_price



Other names

Context

Layout $$$$$$$$.$$

Data domain 0.00 to 99999999.99

Guide for use There is no set manufacturer's price and it will be subsidised at the price at which it is obtained by the pharmacy as long as it is flagged CBS in the schedule.

Verification rules

Collection methods

Related data

Source document

Source organisation



Cost, Brand, Source of supply (CBS) unit price ex GST Definition

Column name cbs_unit_price_exgst



Other names

Context

Layout nnnnnnnn.nn

Data domain

Guide for use The item is eligible for subsidy on the pharmacy's annotated purchase price, brand and source of supply. There is no set manufacturer's price and it will be subsidised at the price at which it is obtained by the pharmacy as long as it is flagged CBS in the schedule. This is exclusive of GST.

Verification rules

Collection methods

Related data

Source document

Source organisation



DSS count Definition

Column name dss_count


Data type integer

Other names

Context

Layout

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Daily dose Definition The amount of base units prescribed to be used per day in the dose unit

of measure defined by Pharmac.

Column name daily_dose



Other names

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99

Guide for use Supplied from HealthPAC item since Claim approved date of 1 May 2000. From June 2001 missing data mapped by multiplying dose by frequency if they exist. Not always an integer because, if not provided, the value is derived. If the Daily dose is unable to be expressed (eg, 'Take as needed'), this field should be set to '0'. If the field is set to '0', the Dose flag should be set to 'Y'. If the number of units is a range, the higher amount is used. If it is greater than zero insert value, else if Dose and Frequency > 0 then Daily_Dose = Dose x Frequency. If the units are spread over alternate days, eg, every other day, or Monday, Wednesday and Friday, the value should represent this: For example, one unit every other day will equate to 0.5 of a unit. For example, Monday, Wednesday, and Friday will equate to 0.4285. As this field requires data expressed to 4 decimal places with no decimal points, 0.5 of a unit would appear in the data file as 5000, and 0.4285 would appear as 4285.

Verification rules

Collection methods

Related data Frequency Quantity Days Supply Dose


Source organisation



Data source Definition Indicates the type of claim code used in the Pharmacode field.

Column name data_source



Other names

Context

Layout A

Data domain C Compound H HealthPAC M Medicode P Pharmacode S Manual Pharmacode

Guide for use Originally Data source denoted whether the data came from HealthPAC or North Pronet Systems. From August 1998 all claims were paid through Pronet systems, and this field was used to denote data type. Before 10 August 1998 the value is always H. After that it is C or M or P, or (since September 2001) S. For example, if analysing use of a component, find all records with Data source of 'C'. When the nationwide Pronet system was introduced in 1998, this started the shift of the major drug key from Medicode to Pharmacode. There is a many to many mapping between Medicode and Pharmacode that is reconciled by a third key based on Chemical, Formulation and Product, which links to the Pharmac schedule.

Verification rules If the supplied value is: - 'MCODE', set to 'M' - 'PCODE', set to 'P' - 'CMPND', set to 'C' - 'S', set to 'S'. If no value is supplied, default to 'M' and print a warning.

Collection methods

Related data

Source document

Source organisation




provider.




Other names

Context

Layout YYMMDDA

Data domain


Verification rules

Collection methods

Related data

Source document

Source organisation



Date dispensed Definition The date the medication was given to the patient.

Column name date_dispensed


Data type date

Other names

Context



Guide for use Fully populated since 10 August 1998.

Verification rules

Collection methods

Related data Date dispensed month Date dispensed year


Source organisation



Days supply Definition The number of days? medication the patient has been supplied with at

this time.

Column name days_supply


Data type number(6)

Other names

Context

Layout NNNNNN


Guide for use Calculated by the HealthPAC claim payment process. Often values missing.

Verification rules

Collection methods



Source organisation



Dim Requirement Key Definition The primary key for the Dim Requirement table.

Column name dim_requirement_key


Data type integer

Other names

Context Used to link to to the Fact tables.

Layout NNNNNNNNNN

Data domain

Guide for use '0' means unknown.

Verification rules NZHIS Datamart generated.

Collection methods

Related data

Source document

Source organisation



Dispensing fee code Definition Class of dispensing fee claimed.

Column name dispensing_fee_code


Data type integer

Other names

Context

Layout N

Data domain 0 to 9, null

Guide for use Has been supplied as null since Claim approved date of 1 August 1998. Retained for historical data.

Verification rules

Collection methods

Related data


Source organisation



Dispensing fee value Definition Fee paid to the claimant for dispensing the medication to the patient.

Column name dispensing_fee_value



Other names Professional fee

Context Cost

Layout $$$$$$$$.$$

Data domain 0.00 to 99999999.99

Guide for use One of the variables that go into the Cost breakdown. Includes GST.


Collection methods

Related data


Source organisation



Dispensing fee value exgst Definition

Column name dispensing_fee_value_exgst



Other names

Context

Layout nnnnnnnn.nn

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Dispensings prescribed Definition Number of repeats on a prescription, including the first dispensing.

Column name dispensings_prescribed


Data type integer

Other names

Context

Layout NN

Data domain 0 to 99

Guide for use Used for determining number of dispensings prescribed, as opposed to number used. Unlimited repeats are indicated as 99.

Verification rules

Collection methods

Related data


Source organisation



Dose Definition The number of units prescribed to be used at each use of the

medication measured in Quantity units, for example 1 tablet.

Column name dose



Other names

Context

Layout NNNNN.NN


Guide for use Converted by HealthPAC from a NNNNNN.NNNN format to a NNN.NN format. If the Dose is unable to be expressed (eg, 'Take as needed'), this field should be set to '0'. If the number of units is a range, the higher amount is used. Dose x Frequency = Daily dose

Verification rules

Collection methods



Source organisation



Encrypted NHI number Definition The NHI number in encrypted form.

Column name encrypted_hcu_id



Other names HCU identifier

Context

Layout 3 alphabetic characters plus 4 numerics the last of which is a check digit, and then encrypted into a 11 character string

Data domain System-generated

Guide for use THE NHI NUMBER THE NHI Number is also known as National Health Index, HCU identifier, NHI, HCU, HCU Number, Healthcare User identifier, HCU identification number, NMPI number, Hospital Number, Patient Number. When duplicate records for a healthcare user are merged, one of their NHI numbers will be deemed to be the master (or primary), and the others become event (or secondary) NHI numbers. This does not affect which NHI numbers are used in local systems. The NHI number that is sent in by the data provider is encrypted during the loading process. Only this encrypted NHI number is stored. For the anaysis of healthcare information relating to a unique individual, the master NHI number should be used. Please contact [email protected] for further information on how to obtain the mast encrypted NHI number if you are performing your own data extraction. The Privacy Commissioner considers the NHI number to be personally identifying information like (name, address) so, if it is linked to clinical information, it must be held securely and the healthcare user's privacy protected. The Encrypted NHI number is not considered personally identifying. NZHIS will return data containing unencrypted NHI numbers to providers who have sent it in. Information available to the general public is of a statistical and non-identifiable nature. Researchers requiring identifiable data will usually need approval from an Ethics Committee. VALIDATION The first three characters of an NHI number must be alpha (but not 'I' or 'O'). The 4th or 6th characters must be numeric. The 7th character is a check digit moduls 11. NHI numbers are often included on patient notes and other patient documentation. New numbers can be allocated by health providers who have direct access to the NHI Register The NHI number is supplied by HealthPAC, Medlab South and Pegasus in the extract files then encrypted by NZHIS. The NHI number is the cornerstone of NZHIS?s data collections. It is a unique 7-character identification number assigned to a healthcare user by the National Health Index (NHI) database. The NHI number uniquely identifies healthcare users, and allows linking between different data collections. It is encrypted to ensure privacy of individual records.



ENCRYPTION The NHI number is encrypted using a one-way encryption algorithm. The aim is to provide an encrypted number that can be sent across public (unsecured) networks.

Verification rules Must be registered on the NHI before use. There is a verification algorithm which ensures that the NHI number is in the correct format and is valid.

Collection methods

Related data

Source document http://www.health.govt.nz/our-work/health-identity/national-health-index for more information on the NHI number

Source organisation NZHIS



Form cost Definition Total cost of prescription or items claimed on this form.

Column name form_cost



Other names

Context

Layout $$$$$$$$.$$

Data domain -99999999.99 to 99999999.99

Guide for use Includes GST. This is the sum of all items on the form, and is copied into each dispensing record. As a result, this field should not be aggregated.

Verification rules An invalid value such as null will be converted to zero.

Collection methods

Related data


Source organisation



Form cost ex GST Definition Total cost of prescription or items claimed on this form, less GST

Column name form_cost_exgst



Other names

Context

Layout nnnnnn.nn

Data domain

Guide for use This is the sum of all items on the form, and is copied into each dispensing record. As a result, this field should not be aggregated.

Verification rules Invalid values will be converted to '0'.

Collection methods

Related data


Source organisation



Form number Definition Identifier for each prescription item.

Column name form_number


Data type integer

Other names

Context

Layout NNNNN


Guide for use Used as one of the keys to match form and item. Recommend this is used in conjunction with date or claimant, depending on the level of aggregation. For some pharmacies this is not a unique number.

Verification rules

Collection methods

Related data

Source document from HealthPAC form and item

Source organisation



Form pack business key Definition The form_pack_bk is generated to provide a business key to

form/pack/subsidy relationships. This allows a link between the Form Pack Subsidy table and the Dispensing table.

Column name form_pack_bk



Other names

Context

Layout Free text

Data domain

Guide for use If there is a Pharmacode present the Form Pack BK will be prefixed by with the character P, if not the Form Pack BK will be prefixed with the character F.

Verification rules NZHIS datamart generated object.

Collection methods

Related data

Source document

Source organisation



Form type Definition The type of the prescription form for claims.

Column name form_type


Data type integer

Other names

Context

Layout NN

Data domain

Guide for use Order type should be used instead as HealthPAC derives the Form type from the Order type 1 Pharmacy prescription 2 Practitioner's supply order 3 Controlled drug 4 Controlled practitioner's supply order 5 Hospital prescription 6 Wholesales supply order 7 Bulk supply order 8 Controlled bulk supply order 9 Allergy treatment set 0 10 11 12 Invalid codes assume 1

Verification rules

Collection methods

Related data


Source organisation



Frequency Definition How often the medication is supposed to be taken.

Column name frequency



Other names

Context

Layout NNNN.NN


Guide for use If not present, then it is derived by calculating Daily Dose divided by Dose (if they exist), unless the result is too large to fit in the field.

Verification rules A zero or value greater than 99.99 is converted to a null.

Collection methods


Source document For manual claims from HealthPAC item

Source organisation



HealthPAC Chemical ID Definition Stat identifier of primary active chemical ingredient.

Column name hpac_chemical_id


Data type number(5)

Other names

Context

Layout NNNNN

Data domain 1000 to 9999 or '0' if no HPAC Chemical ID


Verification rules If empty and not CMPND then default to '0' and print warning.

Collection methods

Related data


Source organisation



HealthPAC Cost Ex Supplier Definition Total cost of medication in the schedule, which includes GST.

Column name hpac_cost_ex_supplier_incl



Other names

Context

Layout $$$$$$.$$$$

Data domain -999999.9999 to 999999.9999


Verification rules If empty set to '0'.

Collection methods

Related data


Source organisation



HealthPAC Cost ex Supplier ex GST Definition Total cost of medication in the schedule, ex GST

Column name hpac_cost_ex_supplier_exgst



Other names

Context

Layout nnnnnnnn.nn

Data domain

Guide for use Supplied by HealthPAC since claim approved date of August 3rd 1998

Verification rules If empty set to '0'

Collection methods

Related data

Source document From HealthPAC item

Source organisation



HealthPAC Pack Size Definition Quantity (of base quantities) in a pack.

Column name hpac_pack_size



Other names

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99


Verification rules

Collection methods

Related data


Source organisation



HealthPAC Presentation ID Definition Pharmac identifier of presentation, now known as formulation for a

chemical.

Column name hpac_presentation_id


Data type integer

Other names

Context

Layout NN

Data domain 0 to 99


Verification rules If empty and not a CMPND, set to '0' and print a warning.

Collection methods

Related data


Source organisation



HealthPAC Product Pack ID Definition Comprised of the Product ID and the Pack ID.

Column name hpac_product_pack_id



Other names

Context

Layout NNNNNNNN



Verification rules

Collection methods

Related data


Source organisation



High use card indicator Definition Flag indicating whether patient is a High Use Health Card holder

(HUHC) or a Care Plus enrolee (from 1st of April 2005) at the time of the initial dispensing.

Column name huhc_ind



Other names

Context

Layout X

Data domain

Guide for use Used when looking at health service utilisation. People with higher than usual subsidy. Prior to the 1st of April 2005, the High use card indicator with a value of 'Z' only had one meaning; that the patient was a High Use Health Card holder. From the 1st of April 2005, the High use card indicator with a value of 'Z' will have two meanings: 1 that the patient is a High Use Health Card holder, OR 2 that the patient is a PHO enrolee. Z patient has a High Use Health Card (converted from 'Y' by HealthPAC) or is a Care Plus enrolee space patient does not have a High Use Health Card (converted from 'N' by HealthPAC) other values undefined

Verification rules

Collection methods

Related data


Source organisation



Item number Definition Sequential identifier of an item within a prescription form.

Column name item_number


Data type integer

Other names

Context

Layout NN

Data domain 0 to 99

Guide for use Number of items per form, not including repeats. Part of the major key for the Dispensings table.

Verification rules

Collection methods

Related data


Source organisation



Locum identifier Definition The registration number of the healthcare provider if the provider was a

locum (from Medical Council, NZ Dental Association, etc).

Column name locum_id



Other names

Context

Layout NNNNNNNNNN


Guide for use From Claim approved date of April 2002. Usually temporary Doctor number. Usually reported as 6 digits.

Verification rules

Collection methods

Related data

Source document

Source organisation



National adjustment Definition

Column name national_adjustment



Other names

Context

Layout NNN.NNNN

Data domain 000.0000 to 999.9999

Guide for use From Claim approved date of May 2002. No longer used from 2003. The Triple and Southern pharmacy contracts have clauses which attempt to provide consistent charges to patients regardless of geography (and the contract a particular pharmacy will be paid under). Where payment for an item is less than the patient co-payment, then the National Consistency formula applies. If subsequently, a repeat claim is made (for example) which results in the total cost of all the supplies of the medicine (plus professional fee) being above the patient co-payment, the payment for the initial item must be recalculated under applicable contract. This recalculation (at the higher contract rate) often results in a 'wash-up' value owed on the initial supply (and paid on the repeat), and the national adjustment figure is the 'wash-up' value.


Collection methods

Related data

Source document

Source organisation



National adjustment ex GST Definition

Column name national_adjustment_exgst



Other names

Context

Layout nnnnnnnn.nn

Data domain

Guide for use From Claim approved date of May 2002. No longer used from 2003. Exclusive of GST. The Triple and Southern pharmacy contracts have clauses which attempt to provide consistent charges to patients regardless of geography (and the contract a particular pharmacy will be paid under). Where payment for an item is less than the patient co-payment, then the National Consistency formula applies. If subsequently, a repeat claim is made (for example) which results in the total cost of all the supplies of the medicine (plus professional fee) being above the patient co-payment, the payment for the initial item must be recalculated under applicable contract. This recalculation (at the higher contract rate) often results in a 'wash-up' value owed on the initial supply (and paid on the repeat), and the national adjustment figure is the 'wash-up' value. This figure is exclusive of GST.


Collection methods

Related data

Source document

Source organisation








Other names

Context

Layout A

Data domain

Guide for use Equivalent of the HP variable transaction category. 'O' is part of the pharmaceutical electronic claiming process. Credit line transactions are used to credit a previously submitted claim transaction. These may either be used independantly, to credit a previous transaction claimed, or as part of a resubmission. Credit line transactions need only contain the following data elements in the Transaction Record of a claim file. Transactions may be resubmitted if the transaction field contents have changed. Only items that have been submitted with incorrect data should be resubmitted. Items that have been rejected by the system do not need to be resubmitted through this procedure. If a transaction is resubmitted, the resubmission must be transferred as two transactions. Pre Claim approved date of 1 August 1998: Y Not Subsidised N Subsidised space Undefined Post Claim approved date of 1 August 1998: C Credit I Invoice N Not Subsidised O Balance owing R Resubmission

Verification rules

Collection methods

Related data


Source organisation



Oncology specialty patient grouping Definition This field is used for PCT (Pharmaceutical Cancer Treatment) drugs.

Column name oncology_specialty_patient_gro



Other names

Context

Layout A

Data domain 1 where 1 = medical oncology inpatient 2 where 2 = medical oncology outpatient 3 where 3 = haematology inpatient 4 where 4 = haematology outpatient 5 where 5 = radiology oncology 6 where 6 = paediatric oncology

Guide for use If the patient category is W, it signifies wastage. That is, the drug has been disposed of, as its expiry date has been reached. In this case, there will be no NHI number associated with it.

Verification rules

Collection methods

Related data

Source document

Source organisation



Order type Definition Indicates the type of prescription or order.

Column name order_type


Data type integer

Other names

Context

Layout N

Data domain 1 Prescription 3 Practitioner's supply order (MPSO) 4 Bulk supply order (BSO) 5 Wholesale supply order (WSO) 6 Nicotene replacement therapy (NRT) 7 Oncology Medicines

Guide for use From Claim approved date of April 2002. Since electronic claiming used to work out the Form Type.

Verification rules

Collection methods

Related data

Source document

Source organisation



PEC form number Definition The Pharmacy Electronic Claim form number, supplied by the

pharmacy to identify a prescription.

Column name pec_form_number


Data type integer

Other names

Context

Layout NNNNNNNNNN


Guide for use One number per patient. Data supplied since Claim approved date of 1 October 2000. All pharmaceutical items from the same prescription form, including repeat items, should have the same PEC form number.

Verification rules

Collection methods

Related data


Source organisation








Other names


Layout A


Guide for use

Verification rules

Collection methods

Related data


Source organisation



Patient category Definition Indicates the patient category at the time of the initial dispensing.

Column name patient_category



Other names

Context

Layout X

Data domain A Adult H Hokianga resident J Juvenile 6-18 years O Oral contraception P Welfare benefit/chronically ill. No longer used. Y Child under 6 years U Unknown B C E 0 1 Undefined

Guide for use Age and income category coded on prescription form.

Verification rules

Collection methods

Related data


Source organisation



Patient contribution Definition The amount the patient has to pay for the medication (GST Inclusive).

Column name patient_contribution



Other names

Context

Layout $$$$$$$$.$$

Data domain 0.00 to 99999999.99



Collection methods

Related data


Source organisation



Patient contribution ex GST Definition The amount the patient has to pay for the medication, exclusive of GST.

Column name patient_contribution_exgst



Other names

Context

Layout nnnnnnnn.nn

Data domain



Collection methods

Related data


Source organisation




contraception.




Other names

Context

Layout A




Collection methods

Related data

Source document

Source organisation



Payment authority Definition Code allocated to the IPA, practise, or other group which gives

HealthPAC the authority to make payments to them.

Column name payment_authority


Data type integer

Other names

Context

Layout NNNN


Guide for use The codes are allocated by HealthPAC to practitioners where classification is necessary.

Verification rules

Collection methods

Related data


Source organisation







Data type integer


Context

Layout NNNNNNN




Collection methods

Related data

Source document

Source organisation



Pharms provider type Definition The type code of the provider used by the Pharmhouse.

Column name pharms_provider_type


Data type integer

Other names

Context

Layout NN

Data domain

Guide for use 0 Unknown 1 Doctor converted from Role Type MC 2 Temporary Doctor converted from Role Type MX 3 Dentist converted from Roles Types DC and DX 4 Private Hospital 5 Maternity Hospital 6 Approved Institution 7 Midwife converted from Role Type NC 8 Undefined 9 Optician 10 Podiatrists 11 Midwife 12 Pharmacy 13 Dietitians 14 Physiotherapist 15 Psychologists 16 Chiropractor 17 Medical Radiation Science 18 Medical Laboratory Technologists 19 Occupational Therapist 20 Osteopath

Verification rules

Collection methods

Related data

Source document

Source organisation



Prescription ID Definition Prescription identification that uniquely identifies a form for claim date

and claimant number.

Column name prescription_id


Data type integer

Other names

Context

Layout NNNNNNNNNN


Guide for use This replaced the old identifier in January 2000, which was a 20-digit integer which was a combination of claim date, claimant number and form number. Developed before the Catnip batch number was introduced, and not reviewed. Now unreliable.

Verification rules Add 1 to previous value if the Claimant_Number, Claim_Date or Form_Number changes else use previous value.

Collection methods

Related data

Source document

Source organisation



Prescription number Definition Number given to each item by the pharmacy's system.

Column name prescription_number


Data type integer

Other names

Context

Layout NNNNNNNNN


Guide for use Where a number of pharmaceutical items are combined or compounded, each item should have the same Prescription ID. Supplied from Claim approved date of 26 April 1996.

Verification rules

Collection methods

Related data


Source organisation



Provider number Definition The registration number of the prescriber (from Medical Council, NZ

Dental Association, etc).

Column name provider_number



Other names

Context

Layout NNNNNNNNNN


Guide for use Extended from 5 digits to 6 in October 2000. Zero denotes an unknown doctor. Link to Provider Code in dim_provider Paired with Provider type. May contain invalid values.

Verification rules

Collection methods If a Locum wrote this prescription the Provider number needs to show the healthcare provider the locum is standing in for.

Related data Provider type


Source organisation



Provider type Definition Indicator to identify the type of prescriber.

Column name provider_type



Other names

Context

Layout NNNN

Data domain C CHE D Dentist M Doctor N Nurse O Organisation OP Optrrician U Unknown

Guide for use Indicates the provider?s Registration Board. Since electronic claiming (August 1998) this data has been converted by HealthPAC from the Role Type. Link to Provider Type in dim_provider. Paired field with Provider number.

Verification rules From 20 August 1999, if value is negative or '0', set to '1'.

Collection methods

Related data Provider number


Source organisation



Purchase unit key Definition Generated artificial key for the dim_purchase_unit table

Column name dim_purchase_unit_key


Data type integer

Other names

Context

Layout

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Quantity dispensed Definition Total quantity of medication that was paid, including wastage.




Other names

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99

Guide for use Before 1 August 1998 it was total quantity of medication claimed for subsidy.


Collection methods



Source organisation



Quantity prescribed Definition The quantity of medication claimed.

Column name quantity_prescribed



Other names Quantity dispensed

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99

Guide for use This must be defined using the Quantity units relating to the Pharmacode as specified by Pharmac. Supplied by HealthPAC from Claim approved date of 3 August 1998.

Verification rules

Collection methods

Related data


Source organisation



Quantity units Definition Units in which quantity is measured for manual claims only.

Column name quantity_units



Other names

Context

Layout A

Data domain C Capsules G Grams I International units L Litres M or m Mixture T Tablets U Units X Unknown quantity units space 0 H Missing quantity units

Guide for use This is similar to Base units. However, if you want a unit of quantity, Base units is the recommended value.

Verification rules

Collection methods

Related data


Source organisation



Reimbursement Cost Definition Value reimbursed to the pharmacy, on this dispensing of a prescription

item that includes GST, and can be negative.

Column name reimbursement_cost



Other names Item price

Context

Layout $$$$$$$$.$$

Data domain -99999999.99 to 99999999.99


Verification rules

Collection methods

Related data


Source organisation



Reimbursement Cost ex GST Definition Value reimbursed to the pharmacy, on this dispensing of a prescription

item, not including GST. Can be a negative value.

Column name reimbursement_cost_exgst



Other names Item price ex GST

Context

Layout nnnnnnnn.nn

Data domain


Verification rules

Collection methods

Related data


Source organisation



Repeat sequence number Definition Sequential identifier of repeat dispensings for a prescription item.

Column name repeat_sequence_number


Data type integer

Other names

Context

Layout NN

Data domain 0 to 99

Guide for use Value in the range of 0 to 99 where 0 for a stat supply or single dispensing, or 1 for an initial repeat dispensing and 2+ for repeats.

Verification rules

Collection methods

Related data


Source organisation






Data type number(5)

Other names

Context

Layout NNNNN



Verification rules

Collection methods

Related data


Source organisation







Data type integer

Other names

Context

Layout NN

Data domain 0 to 99

Guide for use

Verification rules

Collection methods

Related data


Source organisation



Retail subsidy Definition Total Schedule cost of medication plus mark-ups and GST.

Column name retail_subsidy



Other names

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99



Collection methods

Related data


Source organisation



Retail subsidy ex GST Definition Total Schedule cost of medication plus mark-ups, exclusive of GST.

Column name retail_subsidy_exgst



Other names

Context

Layout nnnnnnnn.nn

Data domain



Collection methods

Related data


Source organisation



Role type Definition Health Professional Group Code to define the Registration Body used

to identify the Provider.

Column name provider_role_type



Other names

Context

Layout AA

Data domain MC Medical Council of NZ NC Nursing Council of NZ DC Dental Council of NZ MX Temporary Medical Council of NZ code DX Temporary Dental Council of NZ code

Guide for use From Claim approved date of April 2002. HealthPAC maps this field to Provider type.

Verification rules

Collection methods

Related data

Source document

Source organisation



Rounding Definition This field is used to round the transaction item (once all fees have been

applied) to the nearest cent.

Column name rounding



Other names

Context

Layout .NNNN

Data domain .0000 to .9999



Collection methods

Related data

Source document

Source organisation



Rounding ex GST Definition This field is used to round the transaction item (once all fees have been

applied) to the nearest cent, exclusive of GST.

Column name rounding_exgst



Other names

Context

Layout nnnnnnnn.nn

Data domain



Collection methods

Related data

Source document

Source organisation




rural area.




Other names

Context

Layout A




Collection methods

Related data

Source document

Source organisation



Southern patient contribution remainder Definition Southern Patient Contribution remainder. The amount of money the

patient will have to pay on the next repeat.

Column name s_patient_cont_remainder



Other names

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99



Collection methods

Related data

Source document

Source organisation



Southern patient contribution remainder ex GST Definition Southern Patient Contribution remainder. The amount of money the

patient will have to pay on the next repea, exclusive of GST.

Column name s_patient_cont_remainder_exgst



Other names

Context

Layout nnnnnnnn.nn

Data domain



Collection methods

Related data

Source document

Source organisation



Special authority number Definition Special Authority Approval Number which is known as Section 99

Number.

Column name special_authority_number


Data type integer

Other names

Context

Layout NNNNNNN


Guide for use For drugs that are treated differently by Pharmac, where authority is required to dispense the drug. Paired with Special authority type.

Verification rules

Collection methods

Related data


Source organisation



Special authority type Definition Type of Special Authority.

Column name special_authority_type



Other names

Context

Layout AAAA

Data domain

Guide for use For drugs that are treated differently by Pharmac, where authority is required to dispense the drug. Paired with Special authority number. For Claim approved dates before May 2002, this field can be derived from the Special Authority Number. Refer to the Special Authority Reference table. The Special Authority Reference table has not been updated since September 2001, so between September 2001 and May 2002 the data is incomplete. From May 2002, data supplied in the Dispensings table by HealthPAC. CHEM Special Authority CHFA Exceptional Circumstances Central Health Funding Authority HOSP Special Authority MHFA Midland Health Funding Authority NHFA Exceptional Circumstances North Health Funding Authority RISK Special Authority SHFA Exceptional Circumstances South Health Funding Authority SPEC Special Authority TEMP Templeton UNKN Unknown

Verification rules

Collection methods

Related data

Source document









Other names

Context

Layout A



Verification rules

Collection methods

Related data


Source organisation



Subsidy value Definition The cost to the government of subsidising the pharmaceutical.

Column name subsidy_value



Other names

Context

Layout NNNNNNNN.NN

Data domain 0.00 to 99999999.99

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation



Subsidy value ex GST Definition The cost to the government of subsidising the pharmaceutical,

exclusive of GST.

Column name subsidy_value_exgst



Other names

Context

Layout nnnnnnnn.nn

Data domain

Guide for use


Collection methods

Related data Subsidy per unit Quantity dispensed


Source organisation

Error! Unknown document property name. Data Dictionary Patient Flags table


Patient Flags table Table name dim_patient_flags

Definition The Patient Flags table is a matrix of patient flags for linking to the PHA Dispensing Fact table.

Primary key dim_patient_flags_key

Business key patient_flag, huhc_ind, pha_subsidy_card_ind, patient_category, csc_ind

Guide for use Each record contains five patient flags. This table holds every combination used for these patient flags.

Relational rules This dimension table is linked via its primary key dim_patient_flags_key to the foreign key dim_patient_flags_key in the fact_pha_dispensing table.

Data content



Community Service Card Holder Definition Indicates whether patient is a Community Services Card holder at the

time of the initial dispensing.

Column name csc_ind

Table name dim_patient_flags

Data type integer

Other names

Context

Layout N

Data domain 1 CSC converted from Y 2 Code not used since 1 July 1993 3 No CSC converted from N 4 Low cost PHO enrollee null 0 8 Undefined

Guide for use Relates to HCU identifier at a particular point in time. Definition of PHO enrolee changes over time in accordance with the Public Health Strategy. '2' has been disabled.

Verification rules

Collection methods

Related data

Source document

Source organisation



High use card indicator Definition Flag indicating whether patient is a High Use Health Card holder

(HUHC) or a Care Plus enrolee (from 1st of April 2005) at the time of the initial dispensing.

Column name huhc_ind



Other names

Context

Layout X

Data domain

Guide for use Used when looking at health service utilisation. People with higher than usual subsidy. Prior to the 1st of April 2005, the High use card indicator with a value of 'Z' only had one meaning; that the patient was a High Use Health Card holder. From the 1st of April 2005, the High use card indicator with a value of 'Z' will have two meanings: 1 that the patient is a High Use Health Card holder, OR 2 that the patient is a PHO enrolee. Z patient has a High Use Health Card (converted from 'Y' by HealthPAC) or is a Care Plus enrolee space patient does not have a High Use Health Card (converted from 'N' by HealthPAC) other values undefined

Verification rules

Collection methods

Related data


Source organisation








Other names


Layout A


Guide for use

Verification rules

Collection methods

Related data


Source organisation



Patient category Definition Indicates the patient category at the time of the initial dispensing.

Column name patient_category



Other names

Context

Layout X

Data domain A Adult H Hokianga resident J Juvenile 6-18 years O Oral contraception P Welfare benefit/chronically ill. No longer used. Y Child under 6 years U Unknown B C E 0 1 Undefined

Guide for use Age and income category coded on prescription form.

Verification rules

Collection methods

Related data


Source organisation




contraception.




Other names

Context

Layout A




Collection methods

Related data

Source document

Source organisation

Error! Unknown document property name. Data Dictionary Requirement table


Requirement table Table name dim_requirement

Definition Medicode table - held for historical purposes

Primary key dim_requirement_key

Business key requirement_suffix, requirement_number

Guide for use Applies to pre 1998 records

Relational rules This dimension table is linked via its primary key dim_requirement_key to the foreign key in the fact_pha_dispensing table.

Data content



Base units Definition The unit of measure for dispensing and measuring dose (PEC

specifications 2.29 'unit dispensed' and 'unit claimed').

Column name basic_units

Table name dim_requirement


Other names

Context

Layout

Data domain Free text description

Guide for use Examples include tablets, pills, capsules, milligrams. Should agree with the NZ Pharmacy Guild's Generic unit of measure. With the move from Pronet to the GTPS system, units of measure of numerous drugs have been changed. For example, instead of one inhaler being prescribed (which has 200 doses) there are now 200 doses of the inhaler prescribed.

Verification rules

Collection methods

Related data

Source document




Requirement item name Definition Definitive description of pharmaceutical referred to by the Medicode.

Column name requirement_item_name



Other names

Context

Layout Free text

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation






Data type number(5)

Other names

Context

Layout NNNNN



Verification rules

Collection methods

Related data


Source organisation







Data type number(2)

Other names

Context

Layout NN

Data domain 0 to 99

Guide for use

Verification rules

Collection methods

Related data


Source organisation



Short description Definition

Column name short_description



Other names

Context

Layout Free text

Data domain

Guide for use

Verification rules

Collection methods

Related data

Source document

Source organisation

Error! Unknown document property name. Data Dictionary Appendix A: Logical to Physical Table Mapping


Appendix A: Logical to Physical Table Mapping The following list shows the mapping of the logical, or business, table name to the actual physical table name.

Logical (Business) Table Name

Physical Table Name

Claimant table dim_claimant

COS Code Reference table dim_cos

Costing Flags table dim_costing_flags

Dispensing Flags table dim_dispensing_flags

Form Pack Subsidy table dim_form_pack_subsidy

Patient Flags table dim_patient_flags

Requirement table dim_requirement

PHA Claim Fact table fact_pha_claim

PHA Dispensing Adjustments Fact table

fact_pha_disp_adjustments

PHA Dispensing Fact table fact_pha_dispensing

fact_pha_dispensing_3yr fact_pha_dispensing_3yr

Error! Unknown document property name. Data Dictionary Appendix B: List of Shared Dimensions


Appendix B: List of Shared Dimensions Dimension tables are the descriptive or lookup-type tables that link to fact tables. This data mart has a number of shared Dimension tables. The definitions for these dimensions are held in a separate data dictionary called "SHARED Dimensions". The table below lists the shared dimensions within this data mart.

Dimension Table Description

Affiliation table (dim_affiliation)

This table is a matrix of gender and ethnicity code combination. Each row denotes the gender and ethnicity combination applicable to a person at the time of a transaction, i.e. it does not change over time.

Age Band table (dim_age_band)

This dimension table contains a record for each age from 0 to 115 years. The ages are also grouped into 5 and 10 year age bands, the GMS age bands and the PHO CBF Bands

Geo table (dim_geo)

This reference table contains a geographical breakdown of New Zealand at the level of Domicile Code . Each row of the table describes a single Domicile Code, and locates it within broader geographical definitions eg DHB.

Geofile table (dim_geofile)

Demographic data mainly sourced from NZ Statistics. Source: NZ Statistics

Health Care User table (dim_health_care_user)

This reference table contains information about all people who have received healthcare directly from healthcare providers.

Error! Unknown document property name. Data Dictionary Appendix C: List of Views


Appendix C: List of Views The table views used in this datamart are shown below.

View Name Description

dim_claim_approved_date (dim_claim_approved_date)

dim_claim_date (dim_claim_date)

dim_claim_pay_due_date (dim_claim_pay_due_date)

dim_dispensed_date (dim_dispensed_date)

dim_locum (dim_locum)

dim_pha_provider (dim_pha_provider)

Error! Unknown document property name. Data Dictionary Appendix D: Code Table Index


Appendix D: Code Table Index

Code Table Location

Domicile code table http://www.health.govt.nz/nz-health-statistics/data-references/code-tables/common-code-tables/domicile-code-table

File Type code table Pharms Data Dictionary: See File Type

Sex Type code table http://www.health.govt.nz/nz-health-statistics/data-references/code-tables/common-code-tables/sex-type-code-table

Patient Category code table Pharms Data Dictionary: See Patient Category

Provider Type Reference table Pharms Data Dictionary: See Provider Type

Quantity Units code table Pharms Data Dictionary: See Quantity Units

Special Authority Type code table Pharms Data Dictionary: See Special Authority Type

http://www.health.govt.nz/nz-health-statistics/data-references/code-tables/common-code-tables/domicile-code-table



http://www.health.govt.nz/nz-health-statistics/data-references/code-tables/common-code-tables/sex-type-code-table



Error! Unknown document property name. Data Dictionary Appendix E: Data Dictionary Template


Appendix E: Data Dictionary Template

Introduction This appendix explains how data element attributes are organised in the data dictionary template.

Order of elements

Within the dictionary, elements are organised by table, and then alphabetically. An alphabetical index at the back of the data dictionary is provided to assist the user in finding specific elements.

Template

This table explains the template.

Administrative status The operational status (e.g. CURRENT, SUPERSEDED) of the data element. No SUPERSEDED data elements will be included in the Dictionaries.

Reference ID A code that uniquely identifies the data element. If the data element is used in more than one collection, it should retain its Reference ID wherever it appears.

Version number A version number for each data element. A new version number is allocated to a data element/concept when changes have been made to one or more of the following attributes of the definition:

– name – definition – data domain e.g. adding a new value to the field.

Elements with frequently updated code tables, such as the Facility code table, will not be assigned a new version for changes to data domain.

Version date The date the new version number was assigned.

Identifying and defining attributes

Name A single or multi-word designation assigned to a data element. This appears in the heading for each unique data definition in the Dictionaries. Previous names for the data element are included in the Guide for Use section.

Data element type DATA ELEMENT—a unit of data for which the definition, identification, representation and permissible values are specified by means of a set of attributes.

DERIVED DATA ELEMENT—a data element whose values are derived by calculation from the values of other data elements.

COMPOSITE DATA ELEMENT—a data element whose values represent a grouping of the values of other data elements in a specified order.

Definition A statement that expresses the essential nature of a data element and its differentiation from all other data elements.

Context (optional) A designation or description of the application environment or discipline in which a name is applied or from which it originates. This attribute may also include the justification for collecting the items and uses of the information.

Error! Unknown document property name. Data Dictionary Appendix E: Data Dictionary Template


Relational and representational attributes

Data type The type of field in which a data element is held. For example, character, integer, or numeric.

Field size The maximum number of storage units (of the corresponding data type) to represent the data element value. Field size does not generally include characters used to mark logical separations of values e.g. commas, hyphens or slashes.

Layout The representational layout of characters in data element values expressed by a character string representation. For example:

- ‘CCYYMMDD’ for calendar date - ‘N’ for a one-digit numeric field - ‘A’ for a one-character field - ‘X’ for a field that can hold either a character or a digit, and - ‘$$$,$$$,$$$’ for data elements about expenditure.

Data domain The permissible values for the data element. The set of values can be listed or specified by referring to a code table or code tables, for example, ICD-10-AM 2nd Edition.

Guide for use (optional) Additional comments or advice on the interpretation or application of the data element (this attribute has no direct counterpart in the ISO/IEC Standard 11179 but has been included to assist in clarification of issues relating to the classification of data elements). Includes historical information, advice regarding data quality, and alternative names for this data element.

Verification rules (optional)

The rules and/or instructions applied for validating and/or verifying elements, in addition to the formal edits.

Collection methods – Guide for providers (optional)

Comments and advice concerning the capture of data for the particular data element, including guidelines on the design of questions for use in collecting information, and treatment of ‘not stated’ or non-response (this attribute is not specified in the ISO/IEC Standard 11179 but has been added to cover important issues about the actual collection of data).

Related data (optional) A reference between the data element and any related data element in the Dictionary, including the type of this relationship. Examples include: ‘has been superseded by the data element…’, ‘is calculated using the data element…’, and ‘supplements the data element…’.

Administrative attributes

Source document (optional)

The document from which definitional or representational attributes originate.

Source organisation (if available)

The organisation responsible for the source document and/or the development of the data definition (this attribute is not specified in the ISO/IEC Standard 11179 but has been added for completeness). The source organisation is not necessarily the organisation responsible for the on-going development/maintenance of the data element definition. An example of a source organisation is the National Data Policy Group (NDPG).

Error! Unknown document property name. Data Dictionary Appendix F: Logical Groups of Data Elements


Appendix F: Logical Groups of Data Elements Claim Info

Catnip batch number Claim approved date Claim date Claimant number Number safety net cards Payment authority Payment due date Regional Health Authority Claimants

Claimant name Claimant number Role type Trading name Contracts

COS code Cost

Adjustment amount CBS unit price Claim value Cost Cost ex supplier Dispensing fee code Dispensing fee value HBL cost ex supplier INCL National adjustment Patient contribution Patient contribution remainder Retail subsidy S patient cont remainder Subsidy per unit Subsidy value Dose

Daily dose Days supply Dose Frequency Quantity dispensed Quantity prescribed

Geographic groupings

Area Health Board Region Area unit description Area unit number 1991 Area unit number 1996 DHB code DHB name Locality code Locality name Meshblock number 1991 Meshblock number 1996 Regional Health Authority Sub locality code Sub locality name TLA name 1995 TLA number 1995 Ward name 1995 Ward number 1995 Dispensing

CBS flag CBS unit price Component number Data source Date dispensed Dispensings prescribed File type Form number Form type Locum identifier NSS flag PEC form number Prescription ID Provider number Provider type Repeat sequence number Stat indicator Medicode details

Process code Process type Requirement number Requirement suffix

Patients

Encrypted NHI number Exempt indicator High use indicator card Income group NZDep96 Patient category Pharmaceutical details

Base units Brand code Brand name Brand quantity Chemical ID Chemical name Component number Data source Distributor Formulation ID Formulation name HBL chemical ID HBL pack size HBL presentation ID HBL product pack ID Manufacturer Multiple Patient Flag Pharmacode Prescription flag Presentation ID Process type Product ID Quantity units Requirement number Requirement suffix Specified Strength per unit TG ID Providers

Provider number Provider type Special Authority Reference

Special authority number Special authority type

Error! Unknown document property name. Data Dictionary Appendix G: PHARMS Data Mart model


Appendix G: PHARMS Data Mart model

Provider_registration_number

(BK)

Provider_Type (BK)

Provider_Occupation_Desc

Provider_DHB_Code

Provider_Type_Desc

Provider_Occupation

Provider_Address

Provider_Address2

Provider_City

Perorg_Number

Perorg_Name

Health_Professional_Group_Co

de

Current_Practising_Cert

Deregistration_Date

Pharmac_Registration_Number

Pharmac_Provider_Type

Perorg_Title

Perorg_First_Name

Perorg_Second_Name

Practice_Address_1

Practice_Address_2

Practice_Address_3

Source_System

Dim_Provider

Domicile_Code (BK)

Domicile_Name

Area_Unit_code

Area_Unit

TA_Code

TA

Sub_Locality_Code

Sub_Locality

Locality_Code

Locality

HHS_Code

HHS

RHA_Code

Region

DHB_Code

DHB

Rural_Status_Code

Year_Retired

NZDEP_01

Dim_HCU_Geo (Dim_GEO)Form_Pack (BK)

Pharmacode

Quantity

Multiple

Brand_Code

Brand_Name

Manufacturer

Distributor

Formulation_ID

Formulation_Name

Base_Units

Weight (Strength_Per_Unit)

Chemical_ID

Presentation_ID

TG_ID

TG_Level1_ID

TG_Name1

TG_Level2_ID

TG_Name2

TG_Level3_ID

TG_Name3

TGM_ID

Specified

Product_ID

subsidy

alternate

price

cbs

op

change

stamp

Dim_Form_Pack_Subsidy *

CBS_Flag (BK)

NSS_Flag (BK)

Prescriber_Flag (BK)

Prescription_Flag (BK)

Dispensing_Fee_Code (BK)

Dim_Costing_FlagsShared Date Dimension

Dim_Dispensed_Date (Dim_Global_Time)

Requirement_Number (BK)

Requirement_Suffix

Base_Units

Requirement_Item_Name

Short_Description

Dim_Requirement

Child_Resistant_Container

(BK)

Form_Type (BK)

Order_Type (BK)

Stat_Indicator (BK)

Dim_Dispensing_Flags

Shared Date Dimension

Dim_Claim_Approved_Date (Dim_Global_Time)

Mesh_block_2001 (BK)

Mesh_block_1996

Mesh_block_1991

Domicile_Code_2001

Domicile_Name

Domicile_Code_1996

Domicile_Code_1991

Area_Unit_2001

Area_Unit_Name

area_unit_2001_nzdep

Area_Unit_1996

Area_Unit_1991

tla_code_1995

tla_name

ward_1995

ward_name

post_code

rha

dhb_code

dhb

nzdep_01

nzdep_96

public_health_provider

health_district

Area_Unit_2001_NZDEP

Dim_Claimant_Geofile (Dim_Geofile)

Claimant_Number (BK)

Claim_Date (BK)

Catnip_Batch_Number (BK)

Form_Number (BK)

Item_Number (BK)

Component_Number (BK)

Repeat_Sequence_Number (BK)

CBS_Unit_Price

Cost

Cost_Ex_Supplier

Daily_Dose

Data_Source

Days_Supply

Dispensing_Fee_Value

Dose

Form_Cost

Frequency

HBL_Chemical_ID

HBL_Cost_Ex_Supplier_INCL

HBL_Pack_Size

HBL_Presentation_ID

HBL_Product_Pack_ID

Locum_ID

National_Adjustment

Patient_Contribution

Patient_Contribution_Remainder

Pec_Form_Number

Prescription_ID

Prescription_Number

Quantity

Quantity_Prescribed

Quantity_Units

Rounding

S_Patient_Cont_Remainder

Subsidy_Value

Encrypted_HCU_ID

Special_Authority_Number

Special_Authority_Type

Payment_Authority

Dispensings_Prescribed

Pharmac_Provider_type

Role_Type

Oncology_Specialty_Patient_Group

Cos_Code

Retail_Subsidy

Fact_PHA_Dispensing

Age_In_Years

(BK)

Ten_Year_Band

Five_Year_Band

Funding_Band

GMS_Band

Dim_Age_Band


Dim_Claim_Pay_Date (Dim_Global_Time)


Claim_Date (BK)

Catnip_Batch_Number (BK)

Claim_Value

Adjustment_Amount

Number_Safety_Net_Cards

Regional_Health_Authority

File_Type

Fact_PHA_Claim


Trading_Name

Claimant_Name

Regional_Health_Authority

Area_Health_Board_Region

DHB_Code

DHB_Name

Claimant_Address1

Claimant_Address2

Claimant_Address3

Postcode

Funding_DHB_Code

Funding_DHB_Name

Dim_Claimant


Dim_Claim_Date (Dim_Global_Time)

Income_Group (BK)

Patient_Category (BK)

Patient_Flag (BK)

High_Use_Indicator_Card (BK)

Exempt_Indicator (BK)

Dim_Patient_Flags

As per dim_provider

Dim_Locum (Dim_Provider)

Encrypted NHI Number (BK)

Date_of_Birth

Date_of_Death

also includes latest affiliation

Dim_Health_Care_User

Cos_Code (BK)

Description

Dim_Cos

Gender_Code (BK)

Gender

Ethnic_Code_1 (BK)

Ethnicity_1

Ethnic_Code_2 (BK)

Ethnicity_2

Ethnic_Code_3 (BK)

Ethnicity_3

Priority_Ethnic_Code (BK)

Priority_Ethnicity

Level_1_Ethnic_Code_1

Level_1_Ethnicity_1


Level_1_Ethnicity_2


Level_1_Ethnicity_3

Level_1_Prior_Ethnic_Code

Level_1_Prior_Ethnicity


Level_0_Ethnicity_1


Level_0_Ethnicity_2


Level_0_Ethnicity_3

Level_0_Priority_Ethnic_Code

Level_0_Priority_Ethnicity

Dim_HCU_Disp_Affiliation (Dim_Affiliation)

About the Model

The business key for each

dimension is denoted with (BK)

appearing alongside the relevant

column(s).

Many of the dimension tables

are referenced multiple times or

are being used for a specific

purpose that requires

clarification. For clarity the

logical name of the dimension is

displayed with the physial table

name in brackets e.g.

Dim_Claimang_Geofile

(Dim_Geofile)

The fact tables link to the

dimensions joined via surrogate

keys. On the fact tables the

logical dimension name is used

to label the key e.g.

dim_claim_date_key instead of

dim_global_time_key

* Dim_Form_Pack_Subsidy is a slowly

changing dimension. The subsidy associated

with a pack may change over time.

Documents

Pharmaceutical Claims Data Mart (PHARMS) DATA MART - DATA ... · The Pharmaceutical Claims Data Mart (Pharms DM) is a data mart that supports the management of pharmaceutical subsidies