Australian Base Implementation Guide

This page is part of AU Base v4.0.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-healthcarecardnumber

AU Health Care Card Number [FMM 2]

This identifier profile defines a Health Care Card number[1] in an Australian context. This definition supports sending the Centrelink Customer Reference Number (CRN)[1][2] (also referred to as unique identifier number (UIN) in the Centrelink Confirmation eServices (CCeS)) as displayed on the individual’s Health Care Card. 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.

Extensions

No extensions are used in this profile.

Examples

Patient with IHI, Medicare card, and Health Care Card

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org.au/fhir/StructureDefinition/au-healthcarecardnumber

This identifier profile defines Health Care Card number in an Australian context. 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.

This profile builds on Identifier.

This profile was published on 2021-11-05 as a draft by Health Level Seven Australia (Patient Administration WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierHealth Care Card Number
... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: HC
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
... value 1..1stringCentrelink CRN as displayed on the Commonwealth Seniors Health Card
Example Centrelink CRN: 307111942H
Max Length: 10

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierHealth Care Card Number
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptDescription 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
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: HC
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
... value Σ1..1stringCentrelink CRN as displayed on the Commonwealth Seniors Health Card
Example General: 123456
Example Centrelink CRN: 307111942H
Max Length: 10
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierHealth Care Card Number
... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: HC
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
... value 1..1stringCentrelink CRN as displayed on the Commonwealth Seniors Health Card
Example Centrelink CRN: 307111942H
Max Length: 10

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierHealth Care Card Number
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptDescription 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
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: HC
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
... value Σ1..1stringCentrelink CRN as displayed on the Commonwealth Seniors Health Card
Example General: 123456
Example Centrelink CRN: 307111942H
Max Length: 10
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-healthcarecardnumber

none defined

Issues & Feedback