Australian Base Implementation Guide (AU Base 2)

AU Base Implementation Guide, published by HL7 Australia. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

1.0 StructureDefinition-au-healthcarecardnumber

AU Health Care Card Number [FMM Level 0]

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

Examples

Patient with IHI, Medicare Number, 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, 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.

This profile builds on Identifier.

This profile was published on Tue Jul 21 00:00:00 UTC 2020 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..1CodeableConceptCoded identifier type for health care card number
Binding: V2 Identifier Type - AU Extended (required)
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
.... text 0..1stringPlain text representation of the concept
Fixed Value: Health Care Card Number
... system 1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
... value 1..1stringCentrelink CRN
Example DHS CRN: 307111942H
Max Length: 10

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierHealth Care Card Number
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI1..1CodeableConceptCoded identifier type for health care card number
Binding: V2 Identifier Type - AU Extended (required)
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
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text ΣI0..1stringPlain text representation of the concept
Fixed Value: Health Care Card Number
... system ΣI1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
... value ΣI1..1stringCentrelink CRN
Example General: 123456
Example DHS CRN: 307111942H
Max Length: 10
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI0..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..1CodeableConceptCoded identifier type for health care card number
Binding: V2 Identifier Type - AU Extended (required)
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
.... text 0..1stringPlain text representation of the concept
Fixed Value: Health Care Card Number
... system 1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
... value 1..1stringCentrelink CRN
Example DHS CRN: 307111942H
Max Length: 10

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierHealth Care Card Number
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI1..1CodeableConceptCoded identifier type for health care card number
Binding: V2 Identifier Type - AU Extended (required)
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
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text ΣI0..1stringPlain text representation of the concept
Fixed Value: Health Care Card Number
... system ΣI1..1uriNamespace for Centrelink Customer Reference Number (CRN)
Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
... value ΣI1..1stringCentrelink CRN
Example General: 123456
Example DHS CRN: 307111942H
Max Length: 10
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI0..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