AU Base

This page is part of the Australian Base IG (v0.9.3: AU Base 1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-patient

AU Base Patient Profile [FMM Level 1]

This profile defines a patient administration details structure that includes core localisation concepts.

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]

Extensions

Extensions used in this profile:

Patient: Indigenous Status ^[1] ^[2]
Patient: Close 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]

Examples

Patient with IHI, Medicare Number, and Health Care Card

Patient with IHI and DVA Number

Patient with no birth date, and eligible for close the gap registration

Patient with BirthTime

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

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

Australian realm Patient profile

This profile builds on Patient.

This profile was published on Wed Sep 06 16:30:54 AEST 2017 as a draft by Health Level Seven Australia (Patient Administration WG).

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

Text Summary
Differential Table
Snapshot Table
All

This profile contains the following variations from Patient:

zero or more extension sliced
- at most one Patient Birth Place extension
- at most one Patient Indigenous Status extension
- at most one Patient Close the Gap Registration extension
- at most one Patient Mother’s Maiden name extension
zero or more identifier sliced
- at most one identifier National Individual Health Identifier
  - at most one IHI Number Status extension
  - at most one IHI Number Record Status extension
- zero or more identifier Medicare Number
- at most one identifier DVA Number
- at most one identifier Health Care Card Identifier
- at most one identifier Pensioner Concession Card Identifier
- at most one identifier Commonwealth Seniors Health Card Identifier
- zero or more identifier Medical Record Number
- zero or more identifier Private Health Insurance Member Number
at most one birthDate Date of birth extended for time and accuracy indicator
- at most one Birth Date Accuracy Indicator extension
- at most one Birth Time extension
at most one deceased[x] sliced
- deceased[x] Deceased Indicator
- deceased[x] Deceased Date Time
  - Deceased Date Accuracy Indicator extension
zero or more communication
zero or more generalPractitioner Usual GP practice or practitioner (Reference as: au-practitioner | au-organisation)
at most one managingOrganization Patient managing organisation (Reference as: au-organisation)

Name	Flags	Card.	Type	Description & Constraints
Patient	I	0..*		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..*	Extension	Slice: Unordered, Open by value:url
birthPlace		0..1	Address	Patient birth place URL: http://hl7.org/fhir/StructureDefinition/birthPlace
indigenous-status		0..1	Coding	Patient indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
close-the-gap-registration		0..1	boolean	Patient Close the Gap registration URL: http://hl7.org.au/fhir/StructureDefinition/close-the-gap-registration
patient-mothersMaidenName		0..1	string	Patient mother's maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
identifier			Identifier	Slice: Unordered, Open by value:system, value:type
identifier		0..1	Identifier	National Individual Health Identifier
extension		0..*	Extension	Slice: Unordered, Open by value:url
ihi-status		0..1	Coding	IHI Number Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
ihi-record-status		0..1	Coding	IHI Number Record Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
type		1..1	CodeableConcept	Coded identifier type for IHI Binding: v2 Identifier Type - AU Extended (required)
coding		0..1	Coding
system		1..1	uri	Required system Fixed Value: http://hl7.org/fhir/v2/0203
code		1..1	code	Fixed Value: NI
text		1..1	string	Fixed Value: IHI
system		1..1	uri	national namespace for ihi Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
value	I	1..1	string	Individual Health Identifier number inv-ihi-0: IHI shall be an exactly 16 digit number inv-ihi-1: IHI prefix is 800360 inv-ihi-2: IHI shall pass the Luhn algorithm check Example IHI number': 8003608166690503 Max Length: 16
identifier		0..*	Identifier	Medicare Number
type		1..1	CodeableConcept	Binding: v2 Identifier Type - AU Extended (required)
coding		0..1	Coding
system		1..1	uri	Fixed Value: http://hl7.org/fhir/v2/0203
code		1..1	code	Fixed Value: MC
text		1..1	string	Fixed Value: Medicare Number
system		1..1	uri	national namespace for medicare Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
value		1..1	string	Medicare Number value including optional individual reference number Example Medicare number': 32788511952 Max Length: 11
period		1..1	Period	Medicare validity period
end		1..1	dateTime	Medicare Expiry Date
identifier	I	0..1	Identifier	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		1..1	CodeableConcept	Binding: v2 Identifier Type - AU Extended (required)
coding	I	0..1	Coding	inv-dva-number-coding: DVA colour coding must be DVL, DVW, DVO or DVG
text		1..1	string
system		1..1	uri	DVA number identifier system Fixed Value: http://ns.electronichealth.net.au/id/dva
value		1..1	string	DVA number value Example DVA number': NBUR9080 Max Length: 9
identifier		0..1	Identifier	Health Care Card Identifier
type		1..1	CodeableConcept	Health Care Card Identifier Type Binding: v2 Identifier Type - AU Extended (required)
coding		0..1	Coding
system		1..1	uri	Fixed Value: http://hl7.org/fhir/v2/0203
code		1..1	code	Fixed Value: HC
text		1..1	string	Fixed Value: Health Care Card Number
system		1..1	uri	namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value		1..1	string	Centrelink Customer Reference Number (CRN) Example DHS CRN': 307111942H Max Length: 10
identifier		0..1	Identifier	Pensioner Concession Card Identifier
type		1..1	CodeableConcept	Pensioner Concession Card Identifier Type Binding: v2 Identifier Type - AU Extended (required)
coding		0..1	Coding
system		1..1	uri	Fixed Value: http://hl7.org/fhir/v2/0203
code		1..1	code	Fixed Value: PEN
text		1..1	string	Fixed Value: Pensioner Concession Card Number
system		1..1	uri	namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value		1..1	string	Centrelink Customer Reference Number (CRN) Example DHS CRN': 307111942H Max Length: 10
identifier		0..1	Identifier	Commonwealth Seniors Health Card Identifier
type		1..1	CodeableConcept	Commonwealth Seniors Health Card Identifier Type Binding: v2 Identifier Type - AU Extended (required)
coding		0..1	Coding
system		1..1	uri	Fixed Value: http://hl7.org.au/fhir/v2/0203
code		1..1	code	Fixed Value: SEN
text		1..1	string	Fixed Value: Commonwealth Seniors Health Card
system		1..1	uri	namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value		1..1	string	Centrelink Customer Reference Number (CRN) Example DHS CRN': 307111942H Max Length: 10
identifier		0..*	Identifier	Medical Record Number
type		1..1	CodeableConcept	Binding: v2 Identifier Type - AU Extended (required)
coding		1..1	Coding
system		1..1	uri	Fixed Value: http://hl7.org/fhir/v2/0203
code		1..1	code	Fixed Value: MR
text		1..1	string	Fixed Value: Medical Record Number
system		1..1	uri	Medical record number system url
value		1..1	string	Medical record number value
assigner		1..1	Reference(Organization)	Medical record number assigning entity
identifier		0..*	Identifier	Private Health Insurance Member Number
type		1..1	CodeableConcept	Binding: v2 Identifier Type - AU Extended (required)
coding		1..1	Coding
system		1..1	uri	Fixed Value: http://hl7.org/fhir/v2/0203
code		1..1	code	Fixed Value: MB
text		1..1	string	Fixed Value: Private Health Insurance Member Number
value		1..1	string	Private health insurer member number
assigner		1..1	Reference(Organization)
display		1..1	string
birthDate		0..1	date	Date of birth extended for time and accuracy indicator
extension		0..*	Extension	Slice: Unordered, Open by value:url
date-accuracy-indicator		0..1	Coding	Birth Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required)
patient-birthTime		0..1	dateTime	Birth Time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
deceased[x]			boolean, dateTime	Slice: Unordered, Open by type:$this
deceased[x]		0..1	boolean	Deceased Indicator
deceased[x]		0..1	dateTime	Deceased Date Time
extension		0..*	Extension	Slice: Unordered, Open by value:url
date-accuracy-indicator		0..1	Coding	Deceased Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required)
communication		0..*	BackboneElement
language		1..1	CodeableConcept	Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-1 (extensible)
generalPractitioner		0..*	Reference(AU Base Practitioner \| AU Base Organisation)	Usual GP practice or practitioner
managingOrganization		0..1	Reference(AU Base Organisation)	Patient managing organisation
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient	I	0..*		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..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible)
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
birthPlace	I	0..1	Address	Patient birth place URL: http://hl7.org/fhir/StructureDefinition/birthPlace
indigenous-status	I	0..1	Coding	Patient indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
close-the-gap-registration	I	0..1	boolean	Patient Close the Gap registration URL: http://hl7.org.au/fhir/StructureDefinition/close-the-gap-registration
patient-mothersMaidenName	I	0..1	string	Patient mother's maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ		Identifier	An identifier for this patient Slice: Unordered, Open by value:system, value:type
identifier	Σ	0..1	Identifier	National Individual Health Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ihi-status		0..1	Coding	IHI Number Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/ihi-status"
valueCoding		1..1	Coding	IHI Number Status Code Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
ihi-record-status		0..1	Coding	IHI Number Record Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/ihi-record-status"
valueCoding		1..1	Coding	IHI Record Status Code Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Coded identifier type for IHI Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Required system Fixed Value: http://hl7.org/fhir/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: NI
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: IHI
system	Σ	1..1	uri	national namespace for ihi Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
value	ΣI	1..1	string	Individual Health Identifier number inv-ihi-0: IHI shall be an exactly 16 digit number inv-ihi-1: IHI prefix is 800360 inv-ihi-2: IHI shall pass the Luhn algorithm check Example General': 123456 Example IHI number': 8003608166690503 Max Length: 16
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)
identifier	Σ	0..*	Identifier	Medicare Number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/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: MC
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Medicare Number
system	Σ	1..1	uri	national namespace for medicare Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
value	Σ	1..1	string	Medicare Number value including optional individual reference number Example General': 123456 Example Medicare number': 32788511952 Max Length: 11
period	Σ	1..1	Period	Medicare validity period
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
start	ΣI	0..1	dateTime	Starting time with inclusive boundary
end	ΣI	1..1	dateTime	Medicare Expiry Date
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier	ΣI	0..1	Identifier	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..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	ΣI	0..1	Coding	Code defined by a terminology system inv-dva-number-coding: DVA colour coding must be DVL, DVW, DVO or DVG
text	Σ	1..1	string	Plain text representation of the concept
system	Σ	1..1	uri	DVA number identifier system Fixed Value: http://ns.electronichealth.net.au/id/dva
value	Σ	1..1	string	DVA number value Example General': 123456 Example DVA number': NBUR9080 Max Length: 9
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)
identifier	Σ	0..1	Identifier	Health Care Card Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Health Care Card Identifier Type Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/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	Σ	1..1	string	Plain text representation of the concept Fixed Value: Health Care Card Number
system	Σ	1..1	uri	namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value	Σ	1..1	string	Centrelink Customer Reference Number (CRN) Example General': 123456 Example DHS 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)
identifier	Σ	0..1	Identifier	Pensioner Concession Card Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Pensioner Concession Card Identifier Type Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/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: PEN
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Pensioner Concession Card Number
system	Σ	1..1	uri	namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value	Σ	1..1	string	Centrelink Customer Reference Number (CRN) Example General': 123456 Example DHS 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)
identifier	Σ	0..1	Identifier	Commonwealth Seniors Health Card Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Commonwealth Seniors Health Card Identifier Type Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/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: SEN
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Commonwealth Seniors Health Card
system	Σ	1..1	uri	namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value	Σ	1..1	string	Centrelink Customer Reference Number (CRN) Example General': 123456 Example DHS 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)
identifier	Σ	0..*	Identifier	Medical Record Number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/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: MR
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Medical Record Number
system	Σ	1..1	uri	Medical record number system url Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
value	Σ	1..1	string	Medical record number value Example General': 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Medical record number assigning entity
identifier	Σ	0..*	Identifier	Private Health Insurance Member Number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/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: MB
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Private Health Insurance Member Number
system	Σ	0..1	uri	The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
value	Σ	1..1	string	Private health insurer member number Example General': 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	ΣI	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Text alternative for the resource
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	0..*	HumanName	A name associated with the patient
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
gender	Σ	0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
birthDate	Σ	0..1	date	Date of birth extended for time and accuracy indicator
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
date-accuracy-indicator	I	0..1	Coding	Birth Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required)
patient-birthTime	I	0..1	dateTime	Birth Time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
value		0..1		Primitive value for date
deceased[x]	?!Σ		boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedBoolean	?!Σ	0..1	boolean	Deceased Indicator
deceasedDateTime	?!Σ	0..1	dateTime	Deceased Date Time
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
date-accuracy-indicator	I	0..1	Coding	Deceased Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required)
value		0..1		Primitive value for dateTime
address	Σ	0..*	Address	Addresses for the individual
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible)
multipleBirth[x]		0..1	boolean, integer	Whether patient is part of a multiple birth
photo		0..*	Attachment	Image of the patient
contact	I	0..*	BackboneElement	A 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..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
relationship		0..*	CodeableConcept	The kind of relationship Binding: v2 Contact Role (extensible)
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
organization	I	0..1	Reference(AU Base Organisation)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
animal	?!ΣI	0..1	BackboneElement	This patient is known to be an animal (non-human)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
species	Σ	1..1	CodeableConcept	E.g. Dog, Cow Binding: AnimalSpecies (example)
breed	Σ	0..1	CodeableConcept	E.g. Poodle, Angus Binding: AnimalBreeds (example)
genderStatus	Σ	0..1	CodeableConcept	E.g. Neutered, Intact Binding: GenderStatus (example)
communication	I	0..*	BackboneElement	A list of Languages which may be used to communicate with the patient about his or her health
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
language		1..1	CodeableConcept	The 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-1 (extensible)
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(AU Base Practitioner \| AU Base Organisation)	Usual GP practice or practitioner
managingOrganization	Σ	0..1	Reference(AU Base Organisation)	Patient managing organisation
link	?!ΣI	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
other	Σ	1..1	Reference(AU Base Patient \| AU Base Related Person)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by \| replaces \| refer \| seealso - type of link Binding: LinkType (required)
Documentation for this format

This profile contains the following variations from Patient:

zero or more extension sliced
- at most one Patient Birth Place extension
- at most one Patient Indigenous Status extension
- at most one Patient Close the Gap Registration extension
- at most one Patient Mother’s Maiden name extension
zero or more identifier sliced
- at most one identifier National Individual Health Identifier
  - at most one IHI Number Status extension
  - at most one IHI Number Record Status extension
- zero or more identifier Medicare Number
- at most one identifier DVA Number
- at most one identifier Health Care Card Identifier
- at most one identifier Pensioner Concession Card Identifier
- at most one identifier Commonwealth Seniors Health Card Identifier
- zero or more identifier Medical Record Number
- zero or more identifier Private Health Insurance Member Number
at most one birthDate Date of birth extended for time and accuracy indicator
- at most one Birth Date Accuracy Indicator extension
- at most one Birth Time extension
at most one deceased[x] sliced
- deceased[x] Deceased Indicator
- deceased[x] Deceased Date Time
  - Deceased Date Accuracy Indicator extension
zero or more communication
zero or more generalPractitioner Usual GP practice or practitioner (Reference as: au-practitioner | au-organisation)
at most one managingOrganization Patient managing organisation (Reference as: au-organisation)

Differential View

Name	Flags	Card.	Type	Description & Constraints
Patient	I	0..*		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..*	Extension	Slice: Unordered, Open by value:url
birthPlace		0..1	Address	Patient birth place URL: http://hl7.org/fhir/StructureDefinition/birthPlace
indigenous-status		0..1	Coding	Patient indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
close-the-gap-registration		0..1	boolean	Patient Close the Gap registration URL: http://hl7.org.au/fhir/StructureDefinition/close-the-gap-registration
patient-mothersMaidenName		0..1	string	Patient mother's maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
identifier			Identifier	Slice: Unordered, Open by value:system, value:type
identifier		0..1	Identifier	National Individual Health Identifier
extension		0..*	Extension	Slice: Unordered, Open by value:url
ihi-status		0..1	Coding	IHI Number Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
ihi-record-status		0..1	Coding	IHI Number Record Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
type		1..1	CodeableConcept	Coded identifier type for IHI Binding: v2 Identifier Type - AU Extended (required)
coding		0..1	Coding
system		1..1	uri	Required system Fixed Value: http://hl7.org/fhir/v2/0203
code		1..1	code	Fixed Value: NI
text		1..1	string	Fixed Value: IHI
system		1..1	uri	national namespace for ihi Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
value	I	1..1	string	Individual Health Identifier number inv-ihi-0: IHI shall be an exactly 16 digit number inv-ihi-1: IHI prefix is 800360 inv-ihi-2: IHI shall pass the Luhn algorithm check Example IHI number': 8003608166690503 Max Length: 16
identifier		0..*	Identifier	Medicare Number
type		1..1	CodeableConcept	Binding: v2 Identifier Type - AU Extended (required)
coding		0..1	Coding
system		1..1	uri	Fixed Value: http://hl7.org/fhir/v2/0203
code		1..1	code	Fixed Value: MC
text		1..1	string	Fixed Value: Medicare Number
system		1..1	uri	national namespace for medicare Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
value		1..1	string	Medicare Number value including optional individual reference number Example Medicare number': 32788511952 Max Length: 11
period		1..1	Period	Medicare validity period
end		1..1	dateTime	Medicare Expiry Date
identifier	I	0..1	Identifier	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		1..1	CodeableConcept	Binding: v2 Identifier Type - AU Extended (required)
coding	I	0..1	Coding	inv-dva-number-coding: DVA colour coding must be DVL, DVW, DVO or DVG
text		1..1	string
system		1..1	uri	DVA number identifier system Fixed Value: http://ns.electronichealth.net.au/id/dva
value		1..1	string	DVA number value Example DVA number': NBUR9080 Max Length: 9
identifier		0..1	Identifier	Health Care Card Identifier
type		1..1	CodeableConcept	Health Care Card Identifier Type Binding: v2 Identifier Type - AU Extended (required)
coding		0..1	Coding
system		1..1	uri	Fixed Value: http://hl7.org/fhir/v2/0203
code		1..1	code	Fixed Value: HC
text		1..1	string	Fixed Value: Health Care Card Number
system		1..1	uri	namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value		1..1	string	Centrelink Customer Reference Number (CRN) Example DHS CRN': 307111942H Max Length: 10
identifier		0..1	Identifier	Pensioner Concession Card Identifier
type		1..1	CodeableConcept	Pensioner Concession Card Identifier Type Binding: v2 Identifier Type - AU Extended (required)
coding		0..1	Coding
system		1..1	uri	Fixed Value: http://hl7.org/fhir/v2/0203
code		1..1	code	Fixed Value: PEN
text		1..1	string	Fixed Value: Pensioner Concession Card Number
system		1..1	uri	namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value		1..1	string	Centrelink Customer Reference Number (CRN) Example DHS CRN': 307111942H Max Length: 10
identifier		0..1	Identifier	Commonwealth Seniors Health Card Identifier
type		1..1	CodeableConcept	Commonwealth Seniors Health Card Identifier Type Binding: v2 Identifier Type - AU Extended (required)
coding		0..1	Coding
system		1..1	uri	Fixed Value: http://hl7.org.au/fhir/v2/0203
code		1..1	code	Fixed Value: SEN
text		1..1	string	Fixed Value: Commonwealth Seniors Health Card
system		1..1	uri	namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value		1..1	string	Centrelink Customer Reference Number (CRN) Example DHS CRN': 307111942H Max Length: 10
identifier		0..*	Identifier	Medical Record Number
type		1..1	CodeableConcept	Binding: v2 Identifier Type - AU Extended (required)
coding		1..1	Coding
system		1..1	uri	Fixed Value: http://hl7.org/fhir/v2/0203
code		1..1	code	Fixed Value: MR
text		1..1	string	Fixed Value: Medical Record Number
system		1..1	uri	Medical record number system url
value		1..1	string	Medical record number value
assigner		1..1	Reference(Organization)	Medical record number assigning entity
identifier		0..*	Identifier	Private Health Insurance Member Number
type		1..1	CodeableConcept	Binding: v2 Identifier Type - AU Extended (required)
coding		1..1	Coding
system		1..1	uri	Fixed Value: http://hl7.org/fhir/v2/0203
code		1..1	code	Fixed Value: MB
text		1..1	string	Fixed Value: Private Health Insurance Member Number
value		1..1	string	Private health insurer member number
assigner		1..1	Reference(Organization)
display		1..1	string
birthDate		0..1	date	Date of birth extended for time and accuracy indicator
extension		0..*	Extension	Slice: Unordered, Open by value:url
date-accuracy-indicator		0..1	Coding	Birth Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required)
patient-birthTime		0..1	dateTime	Birth Time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
deceased[x]			boolean, dateTime	Slice: Unordered, Open by type:$this
deceased[x]		0..1	boolean	Deceased Indicator
deceased[x]		0..1	dateTime	Deceased Date Time
extension		0..*	Extension	Slice: Unordered, Open by value:url
date-accuracy-indicator		0..1	Coding	Deceased Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required)
communication		0..*	BackboneElement
language		1..1	CodeableConcept	Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-1 (extensible)
generalPractitioner		0..*	Reference(AU Base Practitioner \| AU Base Organisation)	Usual GP practice or practitioner
managingOrganization		0..1	Reference(AU Base Organisation)	Patient managing organisation
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient	I	0..*		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..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible)
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
birthPlace	I	0..1	Address	Patient birth place URL: http://hl7.org/fhir/StructureDefinition/birthPlace
indigenous-status	I	0..1	Coding	Patient indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
close-the-gap-registration	I	0..1	boolean	Patient Close the Gap registration URL: http://hl7.org.au/fhir/StructureDefinition/close-the-gap-registration
patient-mothersMaidenName	I	0..1	string	Patient mother's maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ		Identifier	An identifier for this patient Slice: Unordered, Open by value:system, value:type
identifier	Σ	0..1	Identifier	National Individual Health Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ihi-status		0..1	Coding	IHI Number Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/ihi-status"
valueCoding		1..1	Coding	IHI Number Status Code Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
ihi-record-status		0..1	Coding	IHI Number Record Status URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/ihi-record-status"
valueCoding		1..1	Coding	IHI Record Status Code Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Coded identifier type for IHI Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Required system Fixed Value: http://hl7.org/fhir/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: NI
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: IHI
system	Σ	1..1	uri	national namespace for ihi Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
value	ΣI	1..1	string	Individual Health Identifier number inv-ihi-0: IHI shall be an exactly 16 digit number inv-ihi-1: IHI prefix is 800360 inv-ihi-2: IHI shall pass the Luhn algorithm check Example General': 123456 Example IHI number': 8003608166690503 Max Length: 16
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)
identifier	Σ	0..*	Identifier	Medicare Number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/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: MC
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Medicare Number
system	Σ	1..1	uri	national namespace for medicare Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
value	Σ	1..1	string	Medicare Number value including optional individual reference number Example General': 123456 Example Medicare number': 32788511952 Max Length: 11
period	Σ	1..1	Period	Medicare validity period
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
start	ΣI	0..1	dateTime	Starting time with inclusive boundary
end	ΣI	1..1	dateTime	Medicare Expiry Date
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier	ΣI	0..1	Identifier	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..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	ΣI	0..1	Coding	Code defined by a terminology system inv-dva-number-coding: DVA colour coding must be DVL, DVW, DVO or DVG
text	Σ	1..1	string	Plain text representation of the concept
system	Σ	1..1	uri	DVA number identifier system Fixed Value: http://ns.electronichealth.net.au/id/dva
value	Σ	1..1	string	DVA number value Example General': 123456 Example DVA number': NBUR9080 Max Length: 9
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)
identifier	Σ	0..1	Identifier	Health Care Card Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Health Care Card Identifier Type Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/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	Σ	1..1	string	Plain text representation of the concept Fixed Value: Health Care Card Number
system	Σ	1..1	uri	namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value	Σ	1..1	string	Centrelink Customer Reference Number (CRN) Example General': 123456 Example DHS 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)
identifier	Σ	0..1	Identifier	Pensioner Concession Card Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Pensioner Concession Card Identifier Type Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/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: PEN
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Pensioner Concession Card Number
system	Σ	1..1	uri	namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value	Σ	1..1	string	Centrelink Customer Reference Number (CRN) Example General': 123456 Example DHS 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)
identifier	Σ	0..1	Identifier	Commonwealth Seniors Health Card Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Commonwealth Seniors Health Card Identifier Type Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/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: SEN
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Commonwealth Seniors Health Card
system	Σ	1..1	uri	namespace for Centrelink CRN identifiers Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value	Σ	1..1	string	Centrelink Customer Reference Number (CRN) Example General': 123456 Example DHS 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)
identifier	Σ	0..*	Identifier	Medical Record Number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/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: MR
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Medical Record Number
system	Σ	1..1	uri	Medical record number system url Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
value	Σ	1..1	string	Medical record number value Example General': 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Medical record number assigning entity
identifier	Σ	0..*	Identifier	Private Health Insurance Member Number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Description of identifier Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/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: MB
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Private Health Insurance Member Number
system	Σ	0..1	uri	The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
value	Σ	1..1	string	Private health insurer member number Example General': 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	ΣI	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Text alternative for the resource
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	0..*	HumanName	A name associated with the patient
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
gender	Σ	0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
birthDate	Σ	0..1	date	Date of birth extended for time and accuracy indicator
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
date-accuracy-indicator	I	0..1	Coding	Birth Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required)
patient-birthTime	I	0..1	dateTime	Birth Time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
value		0..1		Primitive value for date
deceased[x]	?!Σ		boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedBoolean	?!Σ	0..1	boolean	Deceased Indicator
deceasedDateTime	?!Σ	0..1	dateTime	Deceased Date Time
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
date-accuracy-indicator	I	0..1	Coding	Deceased Date Accuracy Indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required)
value		0..1		Primitive value for dateTime
address	Σ	0..*	Address	Addresses for the individual
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible)
multipleBirth[x]		0..1	boolean, integer	Whether patient is part of a multiple birth
photo		0..*	Attachment	Image of the patient
contact	I	0..*	BackboneElement	A 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..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
relationship		0..*	CodeableConcept	The kind of relationship Binding: v2 Contact Role (extensible)
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
organization	I	0..1	Reference(AU Base Organisation)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
animal	?!ΣI	0..1	BackboneElement	This patient is known to be an animal (non-human)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
species	Σ	1..1	CodeableConcept	E.g. Dog, Cow Binding: AnimalSpecies (example)
breed	Σ	0..1	CodeableConcept	E.g. Poodle, Angus Binding: AnimalBreeds (example)
genderStatus	Σ	0..1	CodeableConcept	E.g. Neutered, Intact Binding: GenderStatus (example)
communication	I	0..*	BackboneElement	A list of Languages which may be used to communicate with the patient about his or her health
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
language		1..1	CodeableConcept	The 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-1 (extensible)
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(AU Base Practitioner \| AU Base Organisation)	Usual GP practice or practitioner
managingOrganization	Σ	0..1	Reference(AU Base Organisation)	Patient managing organisation
link	?!ΣI	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
other	Σ	1..1	Reference(AU Base Patient \| AU Base Related Person)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by \| replaces \| refer \| seealso - type of link Binding: LinkType (required)
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-patient

none defined