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.0.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-patient

AU Base Patient Profile [FMM Level 3]

This profile defines a patient administration details structure that includes core localisation concepts for use in an Australian context.

Identifiers

These definitions represent common data held in the Patient.identifier element:

  • Individual Healthcare Identifier - IHI [1] [2]
  • Medicare Number [1] [2]
  • DVA (Department of Veterans’ Affairs) Number [1] [2]
  • Health Care Card Number, Pensioner Concession Card Number, Commonwealth Seniors Health Card Number [1] [2]
  • Medical Record Number - ABN scoped[1], HPI-O scoped[2]
  • Private Health Insurance Member Number

Extensions

Extensions used in this profile:

  • Patient: Indigenous Status [1] [2]
  • Patient: Closing the Gap registration [1] [2]
  • Patient: Birth Place (Core Extension) [1]
  • Patient: Mother’s Maiden Name (Core Extension) [1]
  • Patient.birthDate: Birth Time (Core Extension) [1]
  • Patient.birthDate, Patient.deceasedDateTime: Date Accuracy Indicator [1]
  • Patient.identifier(IHI): IHI Status [1]
  • Patient.identifier(IHI): IHI Record Status [1]

Usage Notes

Mutiple Individual Healthcare Identifiers are supported particularly to support the recording of IHI values where the status and/or record status varies (e.g. deceased, provisional).

Medicare 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 slice further to restrict usage to 11 digits only as desired. Medicare 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 Number, and Health Care Card

Patient with IHI and DVA Number

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

Patient with BirthTime

Patient born in 2008

Patient Sarah Simmons linked to related person Sarah Simmons

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

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

This profile defines a patient administration details structure that includes core localisation concepts for use in an Australian context.

This profile builds on Patient.

This profile was published on Tue Mar 05 23:07:00 UTC 2019 as a active by Health Level Seven Australia (Patient Administration WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*A patient in an Australian healthcare context
inv-pat-0: If there is a birth time its date shall be the birth date
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... patient-birthPlace 0..1AddressPatient Birth Place
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenous-status 0..1CodingPatient Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
... closing-the-gap-registration 0..1booleanPatient Closing the Gap Program Eligibility Indication
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... patient-mothersMaidenName 0..1stringPatient Mother's Maiden Name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... identifier 0..*(Slice Definition)Slice: Unordered, Open by pattern:type, value:system
.... identifier:ihiNumber I0..*IdentifierNational Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... ihi-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
..... ihi-record-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
..... type 0..1CodeableConceptCoded identifier type for IHI
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: NI
...... text 0..1stringFixed Value: IHI
..... system 1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
..... value 1..1stringIHI number
Example IHI number: 8003608833357361
Max Length: 16
.... identifier:medicareNumber 0..*IdentifierMedicare Number
..... type 0..1CodeableConceptCoded identifier type for Medicare 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..1stringFixed Value: Medicare Number
..... system 1..1uriNamespace for Medicare number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
..... value 1..1stringMedicare number including optional individual reference number
Example Medicare number: 32788511952
Max Length: 11
..... period 1..1PeriodMedicare number validity period
...... end 1..1dateTimeMedicare number expiry date
.... identifier:dvaNumber I0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
inv-dva-number-unspecified: DVA number identifier type text must be 'DVA Number' when colour is not specified
inv-dva-number-gold: DVA number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG.
inv-dva-number-white: DVA number identifier type text must be 'DVA Number (White)' when colour coding is DVW.
inv-dva-number-orange: DVA number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO.
inv-dva-number-lilac: DVA number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL.
inv-dva-number-text: DVA number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange), 'DVA Number (Lilac)'
..... type 0..1CodeableConceptCoded identifier type for DVA number
Binding: V2 Identifier Type - AU Extended (required)
...... text 0..1string
..... system 1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
..... value 1..1stringDVA number
Example Department of Veterans' Affairs (DVA) number: NBUR9080
Max Length: 9
.... identifier:healthcareCard 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..1stringFixed 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
.... identifier:pensionerConcessionCard 0..*IdentifierPensioner Concession Card Number
..... type 1..1CodeableConceptCoded identifier type for Pensioner Concession 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: PEN
...... text 0..1stringFixed Value: Pensioner Concession 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
.... identifier:commonwealthSeniorsHealthCard 0..*IdentifierCommonwealth Seniors Health Card Number
..... type 1..1CodeableConceptCoded identifier type for Commonwealth Seniors Health 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.au/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SEN
...... text 0..1stringFixed Value: Commonwealth Seniors Health Card
..... 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
.... identifier:medicalRecordNumber 0..*IdentifierMedical Record Number (MRN)
..... type 1..1CodeableConceptCoded identifier type for MRN
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: MR
...... text 0..1stringFixed Value: Medical Record Number
..... system 1..1uriMedical record number system namespace
..... value 1..1stringMedical record number
..... assigner 1..1Reference(Organization)Medical record number assigning entity
.... identifier:insurerNumber 0..*IdentifierPrivate Health Insurance Member Number
..... type 1..1CodeableConceptCoded identifier type for private health insurance member 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: MB
...... text 0..1stringFixed Value: Private Health Insurance Member Number
..... value 1..1stringPrivate health insurance member number
..... assigner 1..1Reference(Organization)Private health insurer
...... display 1..1string
... birthDate 0..1dateDate of birth extended for time and accuracy indicator
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... date-accuracy-indicator 0..1CodingBirth Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
.... patient-birthTime 0..1dateTimeBirth Time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... deceased[x] 0..1(Slice Definition)Slice: Unordered, Closed by type:$this
.... deceased[x]:deceasedBoolean 0..1booleanDeceased Indicator
.... deceased[x]:deceasedDateTime 0..1dateTimeDeceased Date Time
..... extension 0..1ExtensionSlice: Unordered, Open by value:url
..... date-accuracy-indicator 0..1CodingDeceased Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
... communication 0..*BackboneElement
.... language 1..1CodeableConceptBinding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*A patient in an Australian healthcare context
inv-pat-0: If there is a birth time its date shall be the birth date
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-birthPlace I0..1AddressPatient Birth Place
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenous-status I0..1CodingPatient Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
... closing-the-gap-registration I0..1booleanPatient Closing the Gap Program Eligibility Indication
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... patient-mothersMaidenName I0..1stringPatient Mother's Maiden Name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open by pattern:type, value:system
.... identifier:ihiNumber ΣI0..*IdentifierNational Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ihi-status I0..1CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
..... ihi-record-status I0..1CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptCoded identifier type for IHI
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: NI
....... 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: IHI
..... system ΣI1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
..... value ΣI1..1stringIHI number
Example General: 123456
Example IHI number: 8003608833357361
Max Length: 16
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:medicareNumber ΣI0..*IdentifierMedicare 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 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 number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
..... value ΣI1..1stringMedicare number including optional individual reference number
Example General: 123456
Example Medicare number: 32788511952
Max Length: 11
..... period ΣI1..1PeriodMedicare 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 ΣI1..1dateTimeMedicare number expiry date
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:dvaNumber ΣI0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
inv-dva-number-unspecified: DVA number identifier type text must be 'DVA Number' when colour is not specified
inv-dva-number-gold: DVA number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG.
inv-dva-number-white: DVA number identifier type text must be 'DVA Number (White)' when colour coding is DVW.
inv-dva-number-orange: DVA number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO.
inv-dva-number-lilac: DVA number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL.
inv-dva-number-text: DVA number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange), 'DVA Number (Lilac)'
..... 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 DVA number
Binding: V2 Identifier Type - AU Extended (required)
...... 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
..... system ΣI1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
..... value ΣI1..1stringDVA number
Example General: 123456
Example Department of Veterans' Affairs (DVA) number: NBUR9080
Max Length: 9
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:healthcareCard Σ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)
.... identifier:pensionerConcessionCard ΣI0..*IdentifierPensioner Concession 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 Pensioner Concession 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: PEN
....... 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: Pensioner Concession 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)
.... identifier:commonwealthSeniorsHealthCard ΣI0..*IdentifierCommonwealth Seniors Health 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 Commonwealth Seniors Health 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.au/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SEN
....... 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: Commonwealth Seniors Health Card
..... 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)
.... identifier:medicalRecordNumber ΣI0..*IdentifierMedical Record Number (MRN)
..... 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 MRN
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: MR
....... 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: Medical Record Number
..... system ΣI1..1uriMedical record number system namespace
Example General: http://www.acme.com/identifiers/patient
..... value ΣI1..1stringMedical record number
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI1..1Reference(Organization)Medical record number assigning entity
.... identifier:insurerNumber ΣI0..*IdentifierPrivate Health Insurance Member 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 private health insurance member 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: MB
....... 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: Private Health Insurance Member Number
..... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI1..1stringPrivate health insurance member number
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI1..1Reference(Organization)Private health insurer
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
...... display ΣI1..1stringText alternative for the resource
... active ?!ΣI0..1booleanWhether this patient's record is in active use
... name ΣI0..*HumanNameA name associated with the patient
... telecom ΣI0..*ContactPointA contact detail for the individual
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateDate of birth extended for time and accuracy indicator
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... date-accuracy-indicator I0..1CodingBirth Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
.... patient-birthTime I0..1dateTimeBirth Time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1datePrimitive value for date
... deceased[x] ?!ΣI0..1(Slice Definition)Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
.... deceased[x]:deceasedBoolean ?!ΣI0..1booleanDeceased Indicator
.... deceased[x]:deceasedDateTime ?!ΣI0..1dateTimeDeceased Date Time
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension I0..1ExtensionExtension
Slice: Unordered, Open by value:url
..... date-accuracy-indicator I0..1CodingDeceased Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
..... value 0..1dateTimePrimitive value for dateTime
... address ΣI0..*AddressAn address for the individual
... maritalStatus I0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] I0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo I0..*AttachmentImage of the patient
... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship I0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
.... name I0..1HumanNameA name associated with the contact person
.... telecom I0..*ContactPointA contact detail for the person
.... address I0..1AddressAddress for the contact person
.... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication I0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language I1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
.... preferred I0..1booleanLanguage preference indicator
... generalPractitioner I0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization ΣI0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣI1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type ΣI1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*A patient in an Australian healthcare context
inv-pat-0: If there is a birth time its date shall be the birth date
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... patient-birthPlace 0..1AddressPatient Birth Place
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenous-status 0..1CodingPatient Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
... closing-the-gap-registration 0..1booleanPatient Closing the Gap Program Eligibility Indication
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... patient-mothersMaidenName 0..1stringPatient Mother's Maiden Name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... identifier 0..*(Slice Definition)Slice: Unordered, Open by pattern:type, value:system
.... identifier:ihiNumber I0..*IdentifierNational Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... ihi-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
..... ihi-record-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
..... type 0..1CodeableConceptCoded identifier type for IHI
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: NI
...... text 0..1stringFixed Value: IHI
..... system 1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
..... value 1..1stringIHI number
Example IHI number: 8003608833357361
Max Length: 16
.... identifier:medicareNumber 0..*IdentifierMedicare Number
..... type 0..1CodeableConceptCoded identifier type for Medicare 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..1stringFixed Value: Medicare Number
..... system 1..1uriNamespace for Medicare number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
..... value 1..1stringMedicare number including optional individual reference number
Example Medicare number: 32788511952
Max Length: 11
..... period 1..1PeriodMedicare number validity period
...... end 1..1dateTimeMedicare number expiry date
.... identifier:dvaNumber I0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
inv-dva-number-unspecified: DVA number identifier type text must be 'DVA Number' when colour is not specified
inv-dva-number-gold: DVA number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG.
inv-dva-number-white: DVA number identifier type text must be 'DVA Number (White)' when colour coding is DVW.
inv-dva-number-orange: DVA number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO.
inv-dva-number-lilac: DVA number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL.
inv-dva-number-text: DVA number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange), 'DVA Number (Lilac)'
..... type 0..1CodeableConceptCoded identifier type for DVA number
Binding: V2 Identifier Type - AU Extended (required)
...... text 0..1string
..... system 1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
..... value 1..1stringDVA number
Example Department of Veterans' Affairs (DVA) number: NBUR9080
Max Length: 9
.... identifier:healthcareCard 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..1stringFixed 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
.... identifier:pensionerConcessionCard 0..*IdentifierPensioner Concession Card Number
..... type 1..1CodeableConceptCoded identifier type for Pensioner Concession 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: PEN
...... text 0..1stringFixed Value: Pensioner Concession 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
.... identifier:commonwealthSeniorsHealthCard 0..*IdentifierCommonwealth Seniors Health Card Number
..... type 1..1CodeableConceptCoded identifier type for Commonwealth Seniors Health 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.au/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SEN
...... text 0..1stringFixed Value: Commonwealth Seniors Health Card
..... 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
.... identifier:medicalRecordNumber 0..*IdentifierMedical Record Number (MRN)
..... type 1..1CodeableConceptCoded identifier type for MRN
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: MR
...... text 0..1stringFixed Value: Medical Record Number
..... system 1..1uriMedical record number system namespace
..... value 1..1stringMedical record number
..... assigner 1..1Reference(Organization)Medical record number assigning entity
.... identifier:insurerNumber 0..*IdentifierPrivate Health Insurance Member Number
..... type 1..1CodeableConceptCoded identifier type for private health insurance member 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: MB
...... text 0..1stringFixed Value: Private Health Insurance Member Number
..... value 1..1stringPrivate health insurance member number
..... assigner 1..1Reference(Organization)Private health insurer
...... display 1..1string
... birthDate 0..1dateDate of birth extended for time and accuracy indicator
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... date-accuracy-indicator 0..1CodingBirth Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
.... patient-birthTime 0..1dateTimeBirth Time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... deceased[x] 0..1(Slice Definition)Slice: Unordered, Closed by type:$this
.... deceased[x]:deceasedBoolean 0..1booleanDeceased Indicator
.... deceased[x]:deceasedDateTime 0..1dateTimeDeceased Date Time
..... extension 0..1ExtensionSlice: Unordered, Open by value:url
..... date-accuracy-indicator 0..1CodingDeceased Date Accuracy Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
... communication 0..*BackboneElement
.... language 1..1CodeableConceptBinding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*A patient in an Australian healthcare context
inv-pat-0: If there is a birth time its date shall be the birth date
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-birthPlace I0..1AddressPatient Birth Place
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... indigenous-status I0..1CodingPatient Indigenous Status
URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status
... closing-the-gap-registration I0..1booleanPatient Closing the Gap Program Eligibility Indication
URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
... patient-mothersMaidenName I0..1stringPatient Mother's Maiden Name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open by pattern:type, value:system
.... identifier:ihiNumber ΣI0..*IdentifierNational Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ihi-status I0..1CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
..... ihi-record-status I0..1CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptCoded identifier type for IHI
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: NI
....... 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: IHI
..... system ΣI1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
..... value ΣI1..1stringIHI number
Example General: 123456
Example IHI number: 8003608833357361
Max Length: 16
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:medicareNumber ΣI0..*IdentifierMedicare 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 number
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension