This profile supports Cultural and Linguistic Diversity (CALD) data set ^{[1] [2]}, including country of birth, year of arrival and preferred language.

This profile identifies the additional constraints, extensions, and value sets that build on and extend Patient that are supported.

This profile is designed to set a Patient standard for:

• Query for Patient demographic information

This profile may be referred to by APIs, which will be listed here when available.

Profile specific guidance

• Country of birth is represented using Patient.extension birthPlace extension.
  • A sytem may use address.text if they birth place address is not stored in discrete elements.
• See the Representing communication preferences section for guidance.
• A patient's biological sex is a separate Observation resource, e.g. biological sex assigned at birth conforms to AU Sex Assigned At Birth.

Boundaries and relationships

This profile is not referenced by another profile in this implementation guide.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from AUBasePatient

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	AUBasePatient	A patient in the context of electronic exchange of health information inv-dh-pat-01: At least one patient identifier shall be valid inv-dh-pat-03: If present, a general practitioner shall at least have a reference, an identifier or a display
Slices for extension				Content/Rules for all slices
extension:birthPlace	S	0..1	PatBirthPlace(5.1.0)	Place of Birth for patient
extension:indigenousStatus	S	0..1	AustralianIndigenousStatus	Indigenous status
extension:mothersMaidenName	S	0..1	PatMothersMaidenName(5.1.0)	Mother's Maiden name
extension:interpreterRequired	S	0..1	PatInterpreterRequired(5.1.0)	Whether the patient needs an interpreter
extension:dateOfArrival	S	0..1	DateOfArrivalAustralia	Year of Arrival
identifier	SC	1..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems
active		0..1	boolean	Whether this patient's record is in active use Fixed Value: true
name	S	1..*	HumanName	A name associated with the patient
telecom	S	0..*	ContactPoint	A contact detail for the individual
gender	S	0..1	code	male | female | other | unknown
birthDate	S	0..1	date	Date of birth extended for time and accuracy indicator
Slices for extension				Content/Rules for all slices
extension:accuracyIndicator	S	0..1	DateAccuracyIndicator	Date accuracy indicator
extension:birthTime	S	0..1	PatBirthTime(5.1.0)	Time of day of birth
deceased[x]	S	0..1	boolean, dateTime	Indicates if the individual is deceased or not
Slices for deceasedBoolean				Content/Rules for all slices
deceasedBoolean:deceasedBoolean	S	0..1	boolean	Deceased indicator
Slices for deceasedDateTime				Content/Rules for all slices
deceasedDateTime:deceasedDateTime	S	0..1	dateTime	Deceased date time
Slices for extension				Content/Rules for all slices
extension:accuracyIndicator	S	0..1	DateAccuracyIndicator	Date accuracy indicator
address	S	0..*	AustralianAddress, Address	An address for the individual
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient
multipleBirth[x]	S	0..1	boolean, integer	Whether patient is part of a multiple birth
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient inv-dh-pat-05: If present, a contact's organisation shall at least have a reference, an identifier or a display
relationship	S	0..*	CodeableConcept	The kind of relationship
name	S	0..1	HumanName	A name associated with the contact person
telecom	S	0..*	ContactPoint	A contact detail for the person
address	S	0..1	Address, AustralianAddress	Address for the contact person
gender	S	0..1	code	male | female | other | unknown
organization	S	0..1	Reference(ADHA Core Organization)	Organization that is associated with the contact
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health
preferred	S	0..1	boolean	Language preference indicator
generalPractitioner	SC	0..*	Reference(ADHA Core Organization | ADHA Core PractitionerRole)	Patient's nominated primary care provider
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-pat-01	error	Patient	At least one patient identifier shall be valid : identifier.where(system.count() + value.count() >1).exists()
inv-dh-pat-03	error	Patient	If present, a general practitioner shall at least have a reference, an identifier or a display : generalPractitioner.exists() implies generalPractitioner.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-pat-05	error	Patient.contact	If present, a contact's organisation shall at least have a reference, an identifier or a display : organization.exists() implies (organization.reference.exists() or organization.identifier.exists() or organization.display.exists())

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	AUBasePatient	A patient in the context of electronic exchange of health information inv-pat-0: If present, birth time's date shall be the birth date inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pat-3: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply inv-pat-4: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply inv-dh-pat-01: At least one patient identifier shall be valid inv-dh-pat-03: If present, a general practitioner shall at least have a reference, an identifier or a display
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
birthPlace	S	0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
indigenousStatus	S	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
veteranStatus		0..*	Coding	Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
mothersMaidenName	S	0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
interpreterRequired	S	0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
dateOfArrival	S	0..1	date	Year of Arrival URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
genderIdentity	C	0..*	(Complex)	Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
individualPronouns	C	0..*	(Complex)	Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
recordedSexOrGender	C	0..*	(Complex)	Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SC	1..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems
active	?!Σ	0..1	boolean	Whether this patient's record is in active use Fixed Value: true
name	SΣ	1..*	HumanName	A name associated with the patient
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣC	0..1	date	Date of birth extended for time and accuracy indicator
Slices for extension				Content/Rules for all slices
accuracyIndicator	S	0..1	Coding	Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
birthTime	SC	0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Slices for deceased[x]	?!SΣ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!SΣ	0..1	boolean	Deceased indicator
deceased[x]:deceasedDateTime	?!SΣ	0..1	dateTime	Deceased date time
Slices for extension				Content/Rules for all slices
accuracyIndicator	S	0..1	Coding	Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
address	SC	0..*	AustralianAddress, Address	An address for the individual inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]	S	0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
contact	SC	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 inv-dh-pat-05: If present, a contact's organisation shall at least have a reference, an identifier or a display
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship	S	0..*	CodeableConcept	The kind of relationship Binding: Contact Relationship Type (extensible)
name	S	0..1	HumanName	A name associated with the contact person
telecom	S	0..*	ContactPoint	A contact detail for the person
address	S	0..1	Address, AustralianAddress	Address for the contact person
gender	S	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	SC	0..1	Reference(ADHA Core Organization)	Organization that is associated with the contact
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
preferred	S	0..1	boolean	Language preference indicator
generalPractitioner	SC	0..*	Reference(ADHA Core Organization | ADHA Core PractitionerRole)	Patient's nominated primary care provider
link	?!Σ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.contact.relationship	extensible	ContactRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 from https://tx.ontoserver.csiro.au/fhir
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 from https://tx.ontoserver.csiro.au/fhir
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-pat-01	error	Patient	At least one patient identifier shall be valid : identifier.where(system.count() + value.count() >1).exists()
inv-dh-pat-03	error	Patient	If present, a general practitioner shall at least have a reference, an identifier or a display : generalPractitioner.exists() implies generalPractitioner.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-pat-05	error	Patient.contact	If present, a contact's organisation shall at least have a reference, an identifier or a display : organization.exists() implies (organization.reference.exists() or organization.identifier.exists() or organization.display.exists())

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	AUBasePatient	A patient in the context of electronic exchange of health information inv-pat-0: If present, birth time's date shall be the birth date inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pat-3: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply inv-pat-4: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply inv-dh-pat-01: At least one patient identifier shall be valid inv-dh-pat-03: If present, a general practitioner shall at least have a reference, an identifier or a display
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
birthPlace	S	0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
indigenousStatus	S	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
veteranStatus		0..*	Coding	Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
mothersMaidenName	S	0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
interpreterRequired	S	0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
dateOfArrival	S	0..1	date	Year of Arrival URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
genderIdentity	C	0..*	(Complex)	Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
individualPronouns	C	0..*	(Complex)	Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
recordedSexOrGender	C	0..*	(Complex)	Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SC	1..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems
active	?!Σ	0..1	boolean	Whether this patient's record is in active use Fixed Value: true
name	SΣ	1..*	HumanName	A name associated with the patient
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣC	0..1	date	Date of birth extended for time and accuracy indicator
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
accuracyIndicator	S	0..1	Coding	Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
birthTime	SC	0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
value		0..1	date	Primitive value for date
Slices for deceased[x]	?!SΣ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!SΣ	0..1	boolean	Deceased indicator
deceased[x]:deceasedDateTime	?!SΣ	0..1	dateTime	Deceased date time
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
accuracyIndicator	S	0..1	Coding	Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
value		0..1	dateTime	Primitive value for dateTime
address	SC	0..*	AustralianAddress, Address	An address for the individual inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]	S	0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	SC	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 inv-dh-pat-05: If present, a contact's organisation shall at least have a reference, an identifier or a display
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship	S	0..*	CodeableConcept	The kind of relationship Binding: Contact Relationship Type (extensible)
name	S	0..1	HumanName	A name associated with the contact person
telecom	S	0..*	ContactPoint	A contact detail for the person
address	S	0..1	Address, AustralianAddress	Address for the contact person
gender	S	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	SC	0..1	Reference(ADHA Core Organization)	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
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
preferred	S	0..1	boolean	Language preference indicator
generalPractitioner	SC	0..*	Reference(ADHA Core Organization | ADHA Core PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.contact.relationship	extensible	ContactRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 from https://tx.ontoserver.csiro.au/fhir
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 from https://tx.ontoserver.csiro.au/fhir
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-pat-01	error	Patient	At least one patient identifier shall be valid : identifier.where(system.count() + value.count() >1).exists()
inv-dh-pat-03	error	Patient	If present, a general practitioner shall at least have a reference, an identifier or a display : generalPractitioner.exists() implies generalPractitioner.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-pat-05	error	Patient.contact	If present, a contact's organisation shall at least have a reference, an identifier or a display : organization.exists() implies (organization.reference.exists() or organization.identifier.exists() or organization.display.exists())

Differential View

This structure is derived from AUBasePatient

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	AUBasePatient	A patient in the context of electronic exchange of health information inv-dh-pat-01: At least one patient identifier shall be valid inv-dh-pat-03: If present, a general practitioner shall at least have a reference, an identifier or a display
Slices for extension				Content/Rules for all slices
extension:birthPlace	S	0..1	PatBirthPlace(5.1.0)	Place of Birth for patient
extension:indigenousStatus	S	0..1	AustralianIndigenousStatus	Indigenous status
extension:mothersMaidenName	S	0..1	PatMothersMaidenName(5.1.0)	Mother's Maiden name
extension:interpreterRequired	S	0..1	PatInterpreterRequired(5.1.0)	Whether the patient needs an interpreter
extension:dateOfArrival	S	0..1	DateOfArrivalAustralia	Year of Arrival
identifier	SC	1..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems
active		0..1	boolean	Whether this patient's record is in active use Fixed Value: true
name	S	1..*	HumanName	A name associated with the patient
telecom	S	0..*	ContactPoint	A contact detail for the individual
gender	S	0..1	code	male | female | other | unknown
birthDate	S	0..1	date	Date of birth extended for time and accuracy indicator
Slices for extension				Content/Rules for all slices
extension:accuracyIndicator	S	0..1	DateAccuracyIndicator	Date accuracy indicator
extension:birthTime	S	0..1	PatBirthTime(5.1.0)	Time of day of birth
deceased[x]	S	0..1	boolean, dateTime	Indicates if the individual is deceased or not
Slices for deceasedBoolean				Content/Rules for all slices
deceasedBoolean:deceasedBoolean	S	0..1	boolean	Deceased indicator
Slices for deceasedDateTime				Content/Rules for all slices
deceasedDateTime:deceasedDateTime	S	0..1	dateTime	Deceased date time
Slices for extension				Content/Rules for all slices
extension:accuracyIndicator	S	0..1	DateAccuracyIndicator	Date accuracy indicator
address	S	0..*	AustralianAddress, Address	An address for the individual
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient
multipleBirth[x]	S	0..1	boolean, integer	Whether patient is part of a multiple birth
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient inv-dh-pat-05: If present, a contact's organisation shall at least have a reference, an identifier or a display
relationship	S	0..*	CodeableConcept	The kind of relationship
name	S	0..1	HumanName	A name associated with the contact person
telecom	S	0..*	ContactPoint	A contact detail for the person
address	S	0..1	Address, AustralianAddress	Address for the contact person
gender	S	0..1	code	male | female | other | unknown
organization	S	0..1	Reference(ADHA Core Organization)	Organization that is associated with the contact
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health
preferred	S	0..1	boolean	Language preference indicator
generalPractitioner	SC	0..*	Reference(ADHA Core Organization | ADHA Core PractitionerRole)	Patient's nominated primary care provider
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-pat-01	error	Patient	At least one patient identifier shall be valid : identifier.where(system.count() + value.count() >1).exists()
inv-dh-pat-03	error	Patient	If present, a general practitioner shall at least have a reference, an identifier or a display : generalPractitioner.exists() implies generalPractitioner.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-pat-05	error	Patient.contact	If present, a contact's organisation shall at least have a reference, an identifier or a display : organization.exists() implies (organization.reference.exists() or organization.identifier.exists() or organization.display.exists())

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	AUBasePatient	A patient in the context of electronic exchange of health information inv-pat-0: If present, birth time's date shall be the birth date inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pat-3: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply inv-pat-4: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply inv-dh-pat-01: At least one patient identifier shall be valid inv-dh-pat-03: If present, a general practitioner shall at least have a reference, an identifier or a display
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
birthPlace	S	0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
indigenousStatus	S	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
veteranStatus		0..*	Coding	Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
mothersMaidenName	S	0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
interpreterRequired	S	0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
dateOfArrival	S	0..1	date	Year of Arrival URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
genderIdentity	C	0..*	(Complex)	Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
individualPronouns	C	0..*	(Complex)	Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
recordedSexOrGender	C	0..*	(Complex)	Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SC	1..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems
active	?!Σ	0..1	boolean	Whether this patient's record is in active use Fixed Value: true
name	SΣ	1..*	HumanName	A name associated with the patient
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣC	0..1	date	Date of birth extended for time and accuracy indicator
Slices for extension				Content/Rules for all slices
accuracyIndicator	S	0..1	Coding	Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
birthTime	SC	0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Slices for deceased[x]	?!SΣ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!SΣ	0..1	boolean	Deceased indicator
deceased[x]:deceasedDateTime	?!SΣ	0..1	dateTime	Deceased date time
Slices for extension				Content/Rules for all slices
accuracyIndicator	S	0..1	Coding	Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
address	SC	0..*	AustralianAddress, Address	An address for the individual inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]	S	0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
contact	SC	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 inv-dh-pat-05: If present, a contact's organisation shall at least have a reference, an identifier or a display
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship	S	0..*	CodeableConcept	The kind of relationship Binding: Contact Relationship Type (extensible)
name	S	0..1	HumanName	A name associated with the contact person
telecom	S	0..*	ContactPoint	A contact detail for the person
address	S	0..1	Address, AustralianAddress	Address for the contact person
gender	S	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	SC	0..1	Reference(ADHA Core Organization)	Organization that is associated with the contact
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
preferred	S	0..1	boolean	Language preference indicator
generalPractitioner	SC	0..*	Reference(ADHA Core Organization | ADHA Core PractitionerRole)	Patient's nominated primary care provider
link	?!Σ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.contact.relationship	extensible	ContactRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 from https://tx.ontoserver.csiro.au/fhir
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 from https://tx.ontoserver.csiro.au/fhir
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-pat-01	error	Patient	At least one patient identifier shall be valid : identifier.where(system.count() + value.count() >1).exists()
inv-dh-pat-03	error	Patient	If present, a general practitioner shall at least have a reference, an identifier or a display : generalPractitioner.exists() implies generalPractitioner.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-pat-05	error	Patient.contact	If present, a contact's organisation shall at least have a reference, an identifier or a display : organization.exists() implies (organization.reference.exists() or organization.identifier.exists() or organization.display.exists())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	AUBasePatient	A patient in the context of electronic exchange of health information inv-pat-0: If present, birth time's date shall be the birth date inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pat-3: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply inv-pat-4: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply inv-dh-pat-01: At least one patient identifier shall be valid inv-dh-pat-03: If present, a general practitioner shall at least have a reference, an identifier or a display
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
birthPlace	S	0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
indigenousStatus	S	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
veteranStatus		0..*	Coding	Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
mothersMaidenName	S	0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
interpreterRequired	S	0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
dateOfArrival	S	0..1	date	Year of Arrival URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
genderIdentity	C	0..*	(Complex)	Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
individualPronouns	C	0..*	(Complex)	Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
recordedSexOrGender	C	0..*	(Complex)	Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction - ValueSet AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SC	1..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems
active	?!Σ	0..1	boolean	Whether this patient's record is in active use Fixed Value: true
name	SΣ	1..*	HumanName	A name associated with the patient
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣC	0..1	date	Date of birth extended for time and accuracy indicator
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
accuracyIndicator	S	0..1	Coding	Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
birthTime	SC	0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
value		0..1	date	Primitive value for date
Slices for deceased[x]	?!SΣ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!SΣ	0..1	boolean	Deceased indicator
deceased[x]:deceasedDateTime	?!SΣ	0..1	dateTime	Deceased date time
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
accuracyIndicator	S	0..1	Coding	Date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
value		0..1	dateTime	Primitive value for dateTime
address	SC	0..*	AustralianAddress, Address	An address for the individual inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]	S	0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	SC	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 inv-dh-pat-05: If present, a contact's organisation shall at least have a reference, an identifier or a display
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship	S	0..*	CodeableConcept	The kind of relationship Binding: Contact Relationship Type (extensible)
name	S	0..1	HumanName	A name associated with the contact person
telecom	S	0..*	ContactPoint	A contact detail for the person
address	S	0..1	Address, AustralianAddress	Address for the contact person
gender	S	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	SC	0..1	Reference(ADHA Core Organization)	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
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
preferred	S	0..1	boolean	Language preference indicator
generalPractitioner	SC	0..*	Reference(ADHA Core Organization | ADHA Core PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.contact.relationship	extensible	ContactRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 from https://tx.ontoserver.csiro.au/fhir
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 from https://tx.ontoserver.csiro.au/fhir
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-pat-01	error	Patient	At least one patient identifier shall be valid : identifier.where(system.count() + value.count() >1).exists()
inv-dh-pat-03	error	Patient	If present, a general practitioner shall at least have a reference, an identifier or a display : generalPractitioner.exists() implies generalPractitioner.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-pat-05	error	Patient.contact	If present, a contact's organisation shall at least have a reference, an identifier or a display : organization.exists() implies (organization.reference.exists() or organization.identifier.exists() or organization.display.exists())

This structure is derived from AUBasePatient

Summary

Mandatory: 2 elements
Must-Support: 30 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

• ADHA Core Organization (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-organization-core-1)
• ADHA Core PractitionerRole (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-core-1)

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.