AU Base Implementation Guide
5.1.0-preview - Preview

Publication Build: This will be filled in by the publication tooling

## Data Type Profile: AU Health Care Card Number

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-healthcarecardnumber | Version: 5.1.0-preview
Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUHealthCareCardNumber
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This identifier profile defines Health Care Card number in an Australian context (see Services Australia for further information).

This definition supports sending the Centrelink Customer Reference Number (CRN) (also referred to as unique identifier number (UIN) in the Centrelink Confirmation eServices (CCeS)) as displayed on the individual's Health Care Card (see Services Australia for further information). An individual's CRN is present as the primary identifier on different concession cards and is used to confirm concessions by most government agencies and utility providers.

A Health Care Card is a concession card assigned by Services Australia to benefit recipients, low income earners and selected other groups (e.g. foster children) to assist with certain health costs, by allowing access to specific services at a concessional rate.

### Usage Notes

Usage:

- Use this DataType Constraint: AU Base Coverage, AU Base Patient and AU Base Related Person

Changes since version 5.0.0:

- No changes

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Health Care Card Number ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HC
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value | Σ | 1..1 | string | Centrelink CRN as displayed on the Health Care Card ele-1: All FHIR elements must have a @value or children Example General: 123456 Example Centrelink CRN: 307111942H Max Length:10
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Identifier.type | extensible | Pattern: HC `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |

This structure is derived from Identifier

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Health Care Card Number
type |  | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HC
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value |  | 1..1 | string | Centrelink CRN as displayed on the Health Care Card Example Centrelink CRN: 307111942H Max Length:10
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Health Care Card Number
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HC
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value | Σ | 1..1 | string | Centrelink CRN as displayed on the Health Care Card Example General: 123456 Example Centrelink CRN: 307111942H Max Length:10
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Identifier.type | extensible | Pattern: HC `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Health Care Card Number ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HC
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value | Σ | 1..1 | string | Centrelink CRN as displayed on the Health Care Card ele-1: All FHIR elements must have a @value or children Example General: 123456 Example Centrelink CRN: 307111942H Max Length:10
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Identifier.type | extensible | Pattern: HC `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |

Differential View

This structure is derived from Identifier

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Health Care Card Number
type |  | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HC
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value |  | 1..1 | string | Centrelink CRN as displayed on the Health Care Card Example Centrelink CRN: 307111942H Max Length:10
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Health Care Card Number
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HC
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value | Σ | 1..1 | string | Centrelink CRN as displayed on the Health Care Card Example General: 123456 Example Centrelink CRN: 307111942H Max Length:10
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Identifier.type | extensible | Pattern: HC `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element

Maturity: 2

Other representations of profile: CSV, Excel, Schematron