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-medicarecardnumber

AU Medicare Card Number [FMM Level 0]

This identifier profile defines a Medicare Card Number[1] [2] in an Australian context.

Usage Notes

Medicare Card Number is defined as a 10 or 11 digit number. Whilst 10 digits is not sufficient to uniquely identify an individual it is a supported entry where systems do not support 11 digit content. If required, profiles can constrain this profile further to restrict usage to 11 digits only as desired. Medicare Card Numbers are not used for uniquely identifying patients, they are identifying information that can be used in conjunction with other elements such as name and date of birth appropriately to confirm identity.

Examples

Patient with IHI, Medicare Card Number, and Health Care Card

Patient with no birth date, and eligible for Closing the Gap registration

Patient Sarah Simmons linked to related person Sarah Simmons

Sarah Simmons as the mother of Suzanne Simmons

Bill Simmons as a father of Suzanne Simmons

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

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

This identifier profile defines a Medicare Card Number in an Australian context.

This profile builds on Identifier.

This profile was published on Mon Mar 02 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..*IdentifierMedicare Card Number
... type 0..1CodeableConceptCoded identifier type for Medicare 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: MC
.... text 0..1stringPlain text representation of the concept
Fixed Value: Medicare Number
... system 1..1uriNamespace for Medicare Card Number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
... value 1..1stringMedicare Card Number including optional individual reference number
Example Medicare Card Number: 32788511952
Max Length: 11
... period 0..1PeriodMedicare Card Number validity period
.... end 0..1dateTimeMedicare Card Number expiry date

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierMedicare 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 ΣI0..1CodeableConceptCoded identifier type for Medicare 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: MC
..... 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: Medicare Number
... system ΣI1..1uriNamespace for Medicare Card Number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
... value ΣI1..1stringMedicare Card Number including optional individual reference number
Example General: 123456
Example Medicare Card Number: 32788511952
Max Length: 11
... period ΣI0..1PeriodMedicare Card Number validity period
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣI0..1dateTimeStarting time with inclusive boundary
.... end ΣI0..1dateTimeMedicare Card Number expiry date
... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierMedicare Card Number
... type 0..1CodeableConceptCoded identifier type for Medicare 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: MC
.... text 0..1stringPlain text representation of the concept
Fixed Value: Medicare Number
... system 1..1uriNamespace for Medicare Card Number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
... value 1..1stringMedicare Card Number including optional individual reference number
Example Medicare Card Number: 32788511952
Max Length: 11
... period 0..1PeriodMedicare Card Number validity period
.... end 0..1dateTimeMedicare Card Number expiry date

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierMedicare 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 ΣI0..1CodeableConceptCoded identifier type for Medicare 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: MC
..... 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: Medicare Number
... system ΣI1..1uriNamespace for Medicare Card Number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
... value ΣI1..1stringMedicare Card Number including optional individual reference number
Example General: 123456
Example Medicare Card Number: 32788511952
Max Length: 11
... period ΣI0..1PeriodMedicare Card Number validity period
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣI0..1dateTimeStarting time with inclusive boundary
.... end ΣI0..1dateTimeMedicare Card Number expiry date
... 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-medicarecardnumber

none defined