AU Base 1 on FHIR STU3

This page is part of the Australian Base IG (v1.0.2: AU Base 1 on STU3) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-relatedperson

AU Base RelatedPerson Profile [FMM Level 2]

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

Identifiers

These definitions represent common data held in the RelatedPerson.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 ^[1] ^[2]
Private Health Insurance Member Number

Extensions

Extensions used in this profile:

RelatedPerson.identifier(IHI): IHI Status ^[1]
RelatedPerson.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

Benedicte du Marche as a next of kin

Mary Smith as a carer

Sarah Simmons as the mother of Suzanne Simmons

Bill Simmons as a father of Suzanne Simmons

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

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

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

This profile builds on RelatedPerson.

This profile was published on Tue May 01 00:00:00 AEST 2018 as a active 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 RelatedPerson:

identifier sliced
- identifier National Individual Healthcare Identifier (IHI)
  - Individual Healthcare Identifier (IHI) Number Status extension
  - Individual Healthcare Identifier (IHI) Number Record Status extension
- identifier Medicare Number
- identifier Department of Veterans’ Affairs (DVA) Number
- identifier Health Care Card Number
- identifier Pensioner Concession Card Number
- identifier Commonwealth Seniors Health Card Number
- identifier Medical Record Number (MRN)
- identifier Private Health Insurance Member Number
relationship

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*		A person related to a patient in an Australian healthcare context
identifier			Identifier	Slice: Unordered, Open by pattern:type, value:system
identifier	I	0..*	Identifier	National 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..*	Extension	Slice: Unordered, Open by value:url
ihi-status		0..*	Coding	Individual Healthcare Identifier (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..*	Coding	Individual Healthcare Identifier (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		0..1	CodeableConcept	Coded identifier type for IHI Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"NI"}]}
text		0..1	string	Fixed Value: IHI
system		1..1	uri	Namespace for IHI Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
value		1..1	string	IHI number Example IHI number': 8003608833357361 Max Length: 16
identifier		0..*	Identifier	Medicare Number
type		0..1	CodeableConcept	Coded identifier type for Medicare number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MC"}]}
text		0..1	string	Fixed Value: Medicare Number
system		1..1	uri	Namespace for Medicare number Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
value		1..1	string	Medicare number including optional individual reference number Example Medicare number': 32788511952 Max Length: 11
period		1..1	Period	Medicare number validity period
end		1..1	dateTime	Medicare number expiry date
identifier	I	0..*	Identifier	Department 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..1	CodeableConcept	Coded identifier type for DVA number Binding: v2 Identifier Type - AU Extended (required)
text		0..1	string
system		1..1	uri	Namespace for DVA number Fixed Value: http://ns.electronichealth.net.au/id/dva
value		1..1	string	DVA number Example DVA number': NBUR9080 Max Length: 9
identifier		0..*	Identifier	Health Care Card Number
type		1..1	CodeableConcept	Coded identifier type for Health Care Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC"}]}
text		0..1	string	Fixed Value: Health Care Card Number
system		1..1	uri	Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value		1..1	string	Centrelink CRN Example DHS CRN': 307111942H Max Length: 10
identifier		0..*	Identifier	Pensioner Concession Card Number
type		1..1	CodeableConcept	Coded identifier type for Pensioner Concession Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN"}]}
text		0..1	string	Fixed Value: Pensioner Concession Card Number
system		1..1	uri	Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value		1..1	string	Centrelink CRN Example DHS CRN': 307111942H Max Length: 10
identifier		0..*	Identifier	Commonwealth Seniors Health Card Number
type		1..1	CodeableConcept	Coded identifier type for Commonwealth Seniors Health Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN"}]}
text		0..1	string	Fixed Value: Commonwealth Seniors Health Card
system		1..1	uri	Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value		1..1	string	Centrelink CRN Example DHS CRN': 307111942H Max Length: 10
identifier		0..*	Identifier	Medical Record Number (MRN)
type		1..1	CodeableConcept	Coded identifier type for MRN Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MR"}]}
text		0..1	string	Fixed Value: Medical Record Number
system		1..1	uri	Medical record number system namespace
value		1..1	string	Medical record number
assigner		1..1	Reference(Organization)	Medical record number assigning entity
identifier		0..*	Identifier	Private Health Insurance Member Number
type		1..1	CodeableConcept	Coded identifier type for private health insurance member number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MB"}]}
text		0..1	string	Fixed Value: Private Health Insurance Member Number
value		1..1	string	Private health insurance member number
assigner		1..1	Reference(Organization)	Private health insurer
display		1..1	string
relationship		0..1	CodeableConcept	Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	I	0..*		A person related to a patient in an Australian healthcare context
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) Max Binding: All Languages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ		Identifier	A human identifier for this person Slice: Unordered, Open by pattern:type, value:system
identifier	ΣI	0..*	Identifier	National 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..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ihi-status		0..*	Coding	Individual Healthcare Identifier (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..*	Coding	Individual Healthcare Identifier (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	Σ	0..1	CodeableConcept	Coded identifier type for IHI Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"NI"}]}
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..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: IHI
system	Σ	1..1	uri	Namespace for IHI Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
value	Σ	1..1	string	IHI number Example General': 123456 Example IHI number': 8003608833357361 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	Σ	0..1	CodeableConcept	Coded identifier type for Medicare number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MC"}]}
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..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Medicare Number
system	Σ	1..1	uri	Namespace for Medicare number Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
value	Σ	1..1	string	Medicare number including optional individual reference number Example General': 123456 Example Medicare number': 32788511952 Max Length: 11
period	Σ	1..1	Period	Medicare number 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 number expiry date
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier	ΣI	0..*	Identifier	Department 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..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	Σ	0..1	CodeableConcept	Coded identifier type for DVA number 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..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	1..1	uri	Namespace for DVA number Fixed Value: http://ns.electronichealth.net.au/id/dva
value	Σ	1..1	string	DVA number 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..*	Identifier	Health Care Card 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	Coded identifier type for Health Care Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC"}]}
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..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Health Care Card Number
system	Σ	1..1	uri	Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value	Σ	1..1	string	Centrelink 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	Pensioner Concession Card 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	Coded identifier type for Pensioner Concession Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN"}]}
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..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Pensioner Concession Card Number
system	Σ	1..1	uri	Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value	Σ	1..1	string	Centrelink 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	Commonwealth Seniors Health Card 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	Coded identifier type for Commonwealth Seniors Health Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN"}]}
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..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Commonwealth Seniors Health Card
system	Σ	1..1	uri	Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value	Σ	1..1	string	Centrelink 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 (MRN)
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	Coded identifier type for MRN Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MR"}]}
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..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Medical Record Number
system	Σ	1..1	uri	Medical record number system namespace 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 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	Coded identifier type for private health insurance member number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MB"}]}
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..*	Coding	Code defined by a terminology system
text	Σ	0..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 insurance member number Example General': 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Private health insurer
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 related person's record is in active use
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
relationship	Σ	0..1	CodeableConcept	The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)
name	Σ	0..*	HumanName	A name associated with the person
telecom	Σ	0..*	ContactPoint	A contact detail for the person
gender	Σ	0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
birthDate	Σ	0..1	date	The date on which the related person was born
address	Σ	0..*	Address	Address where the related person can be contacted or visited
photo		0..*	Attachment	Image of the person
period		0..1	Period	Period of time that this relationship is considered valid
Documentation for this format

This profile contains the following variations from RelatedPerson:

identifier sliced
- identifier National Individual Healthcare Identifier (IHI)
  - Individual Healthcare Identifier (IHI) Number Status extension
  - Individual Healthcare Identifier (IHI) Number Record Status extension
- identifier Medicare Number
- identifier Department of Veterans’ Affairs (DVA) Number
- identifier Health Care Card Number
- identifier Pensioner Concession Card Number
- identifier Commonwealth Seniors Health Card Number
- identifier Medical Record Number (MRN)
- identifier Private Health Insurance Member Number
relationship

Differential View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*		A person related to a patient in an Australian healthcare context
identifier			Identifier	Slice: Unordered, Open by pattern:type, value:system
identifier	I	0..*	Identifier	National 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..*	Extension	Slice: Unordered, Open by value:url
ihi-status		0..*	Coding	Individual Healthcare Identifier (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..*	Coding	Individual Healthcare Identifier (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		0..1	CodeableConcept	Coded identifier type for IHI Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"NI"}]}
text		0..1	string	Fixed Value: IHI
system		1..1	uri	Namespace for IHI Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
value		1..1	string	IHI number Example IHI number': 8003608833357361 Max Length: 16
identifier		0..*	Identifier	Medicare Number
type		0..1	CodeableConcept	Coded identifier type for Medicare number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MC"}]}
text		0..1	string	Fixed Value: Medicare Number
system		1..1	uri	Namespace for Medicare number Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
value		1..1	string	Medicare number including optional individual reference number Example Medicare number': 32788511952 Max Length: 11
period		1..1	Period	Medicare number validity period
end		1..1	dateTime	Medicare number expiry date
identifier	I	0..*	Identifier	Department 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..1	CodeableConcept	Coded identifier type for DVA number Binding: v2 Identifier Type - AU Extended (required)
text		0..1	string
system		1..1	uri	Namespace for DVA number Fixed Value: http://ns.electronichealth.net.au/id/dva
value		1..1	string	DVA number Example DVA number': NBUR9080 Max Length: 9
identifier		0..*	Identifier	Health Care Card Number
type		1..1	CodeableConcept	Coded identifier type for Health Care Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC"}]}
text		0..1	string	Fixed Value: Health Care Card Number
system		1..1	uri	Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value		1..1	string	Centrelink CRN Example DHS CRN': 307111942H Max Length: 10
identifier		0..*	Identifier	Pensioner Concession Card Number
type		1..1	CodeableConcept	Coded identifier type for Pensioner Concession Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN"}]}
text		0..1	string	Fixed Value: Pensioner Concession Card Number
system		1..1	uri	Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value		1..1	string	Centrelink CRN Example DHS CRN': 307111942H Max Length: 10
identifier		0..*	Identifier	Commonwealth Seniors Health Card Number
type		1..1	CodeableConcept	Coded identifier type for Commonwealth Seniors Health Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN"}]}
text		0..1	string	Fixed Value: Commonwealth Seniors Health Card
system		1..1	uri	Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value		1..1	string	Centrelink CRN Example DHS CRN': 307111942H Max Length: 10
identifier		0..*	Identifier	Medical Record Number (MRN)
type		1..1	CodeableConcept	Coded identifier type for MRN Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MR"}]}
text		0..1	string	Fixed Value: Medical Record Number
system		1..1	uri	Medical record number system namespace
value		1..1	string	Medical record number
assigner		1..1	Reference(Organization)	Medical record number assigning entity
identifier		0..*	Identifier	Private Health Insurance Member Number
type		1..1	CodeableConcept	Coded identifier type for private health insurance member number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MB"}]}
text		0..1	string	Fixed Value: Private Health Insurance Member Number
value		1..1	string	Private health insurance member number
assigner		1..1	Reference(Organization)	Private health insurer
display		1..1	string
relationship		0..1	CodeableConcept	Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	I	0..*		A person related to a patient in an Australian healthcare context
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) Max Binding: All Languages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ		Identifier	A human identifier for this person Slice: Unordered, Open by pattern:type, value:system
identifier	ΣI	0..*	Identifier	National 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..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ihi-status		0..*	Coding	Individual Healthcare Identifier (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..*	Coding	Individual Healthcare Identifier (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	Σ	0..1	CodeableConcept	Coded identifier type for IHI Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"NI"}]}
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..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: IHI
system	Σ	1..1	uri	Namespace for IHI Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
value	Σ	1..1	string	IHI number Example General': 123456 Example IHI number': 8003608833357361 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	Σ	0..1	CodeableConcept	Coded identifier type for Medicare number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MC"}]}
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..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Medicare Number
system	Σ	1..1	uri	Namespace for Medicare number Fixed Value: http://ns.electronichealth.net.au/id/medicare-number
value	Σ	1..1	string	Medicare number including optional individual reference number Example General': 123456 Example Medicare number': 32788511952 Max Length: 11
period	Σ	1..1	Period	Medicare number 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 number expiry date
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier	ΣI	0..*	Identifier	Department 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..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	Σ	0..1	CodeableConcept	Coded identifier type for DVA number 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..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	1..1	uri	Namespace for DVA number Fixed Value: http://ns.electronichealth.net.au/id/dva
value	Σ	1..1	string	DVA number 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..*	Identifier	Health Care Card 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	Coded identifier type for Health Care Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"HC"}]}
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..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Health Care Card Number
system	Σ	1..1	uri	Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value	Σ	1..1	string	Centrelink 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	Pensioner Concession Card 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	Coded identifier type for Pensioner Concession Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PEN"}]}
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..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Pensioner Concession Card Number
system	Σ	1..1	uri	Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value	Σ	1..1	string	Centrelink 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	Commonwealth Seniors Health Card 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	Coded identifier type for Commonwealth Seniors Health Card number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"SEN"}]}
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..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Commonwealth Seniors Health Card
system	Σ	1..1	uri	Namespace for Centrelink Customer Reference Number (CRN) Fixed Value: http://ns.electronichealth.net.au/id/centrelink-customer-reference-number
value	Σ	1..1	string	Centrelink 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 (MRN)
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	Coded identifier type for MRN Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MR"}]}
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..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Medical Record Number
system	Σ	1..1	uri	Medical record number system namespace 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 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	Coded identifier type for private health insurance member number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"MB"}]}
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..*	Coding	Code defined by a terminology system
text	Σ	0..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 insurance member number Example General': 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Private health insurer
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 related person's record is in active use
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
relationship	Σ	0..1	CodeableConcept	The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)
name	Σ	0..*	HumanName	A name associated with the person
telecom	Σ	0..*	ContactPoint	A contact detail for the person
gender	Σ	0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
birthDate	Σ	0..1	date	The date on which the related person was born
address	Σ	0..*	Address	Address where the related person can be contacted or visited
photo		0..*	Attachment	Image of the person
period		0..1	Period	Period of time that this relationship is considered valid
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-relatedperson

none defined