cvis_fhir, published by Example Publisher. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Nommable/FHIR_10102025/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: MyPatient

My patient profile

Usages:

• This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	AUCorePatient	A patient in the context of electronic exchange of health information Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:indigenousStatus	SO	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
extension:veteranStatus		0..*	Coding	Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
extension:closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
extension:mothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
extension:interpreterRequired		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension:dateOfArrival		0..1	date	The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
extension:genderIdentity	SOC	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 Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
extension:individualPronouns	SOC	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 Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
extension: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
Slices for identifier	SOΣC	1..1	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
identifier:ihi	SOΣ	0..1	AUIHI	Identifies this patient across multiple systems Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
identifier:medicare	SOΣ	0..1	AUMedicareCardNumber	Identifies this patient across multiple systems Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
identifier:dva	SOΣ	0..1	AUDVANumber	Identifies this patient across multiple systems Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SOΣC	1..*	HumanName	A name associated with the patient Constraints: au-core-pat-03 Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
use	?!SOΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
text	SOΣ	0..1	string	Text representation of the full name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
family	SOΣ	1..1	string	Family name (often called 'Surname') Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
given	SOΣ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
telecom	SOΣ	0..*	ContactPoint	A contact detail for the individual Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
gender	SOΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
birthDate	SOΣC	1..1	date	Date of birth extended for time and accuracy indicator Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
Slices for extension				Content/Rules for all slices
extension:accuracyIndicator		0..1	Coding	Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
extension:birthTime	C	0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Deceased indicator
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Deceased date time
Slices for extension				Content/Rules for all slices
extension:accuracyIndicator		0..1	Coding	Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
address	SOΣ	0..*	AustralianAddress, Address	An address for the individual Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
communication	SO	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	SO	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) Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
preferred	SO	0..1	boolean	Language preference indicator Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
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	Status	Usage	ValueSet	Version	Source
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	extensible	Common Languages in Australia	⏿2.2.1	tx.ontoserver.csiro.au
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
au-core-pat-01	error	Patient	At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present	(identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
au-core-pat-02	error	Patient	At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present	name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
au-core-pat-03	error	Patient.name	At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present	(text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
inv-pat-0	error	Patient	If present, birth time's date shall be the birth date	birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString()
inv-pat-1	warning	Patient	Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-pat-2	warning	Patient	Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-pat-3	warning	Patient	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-pat-4	warning	Patient	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-pat-5	warning	Patient	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))

This structure is derived from AUCorePatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	AUCorePatient	A patient in the context of electronic exchange of health information
identifier		1..1	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems
name
family		1..1	string	Family name (often called 'Surname')
given		1..*	string	Given names (not always 'first'). Includes middle names
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	AUCorePatient	A patient in the context of electronic exchange of health information Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:indigenousStatus	SO	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
extension:veteranStatus		0..*	Coding	Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
extension:closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
extension:mothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
extension:interpreterRequired		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension:dateOfArrival		0..1	date	The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
extension:genderIdentity	SOC	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 Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
extension:individualPronouns	SOC	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 Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
extension: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
Slices for identifier	SOΣC	1..1	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
identifier:ihi	SOΣ	0..1	AUIHI	Identifies this patient across multiple systems Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
identifier:medicare	SOΣ	0..1	AUMedicareCardNumber	Identifies this patient across multiple systems Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
identifier:dva	SOΣ	0..1	AUDVANumber	Identifies this patient across multiple systems Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SOΣC	1..*	HumanName	A name associated with the patient Constraints: au-core-pat-03 Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SOΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
text	SOΣ	0..1	string	Text representation of the full name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
family	SOΣ	1..1	string	Family name (often called 'Surname') Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
given	SOΣ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SOΣ	0..*	ContactPoint	A contact detail for the individual Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
gender	SOΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
birthDate	SOΣC	1..1	date	Date of birth extended for time and accuracy indicator Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:accuracyIndicator		0..1	Coding	Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
extension:birthTime	C	0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
value		0..1	date	Primitive value for date
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Deceased indicator
deceased[x]:deceasedDateTime	?!Σ	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
extension:accuracyIndicator		0..1	Coding	Deceased 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	SOΣ	0..*	AustralianAddress, Address	An address for the individual Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
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		0..*	CodeableConcept	The kind of relationship Binding: Contact Relationship Type (extensible)
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address, AustralianAddress	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(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	SO	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
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	SO	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) Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
preferred	SO	0..1	boolean	Language preference indicator Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
generalPractitioner		0..*	Reference(Organization | Practitioner | 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	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	MaritalStatus	📦4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Contact Relationship Type	⏿3.1.0	tx.ontoserver.csiro.au
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	extensible	Common Languages in Australia	⏿2.2.1	tx.ontoserver.csiro.au
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
au-core-pat-01	error	Patient	At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present	(identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
au-core-pat-02	error	Patient	At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present	name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
au-core-pat-03	error	Patient.name	At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present	(text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
inv-pat-0	error	Patient	If present, birth time's date shall be the birth date	birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString()
inv-pat-1	warning	Patient	Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-pat-2	warning	Patient	Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-pat-3	warning	Patient	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-pat-4	warning	Patient	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-pat-5	warning	Patient	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from AUCorePatient

Summary

Mandatory: 2 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	AUCorePatient	A patient in the context of electronic exchange of health information Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:indigenousStatus	SO	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
extension:veteranStatus		0..*	Coding	Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
extension:closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
extension:mothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
extension:interpreterRequired		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension:dateOfArrival		0..1	date	The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
extension:genderIdentity	SOC	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 Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
extension:individualPronouns	SOC	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 Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
extension: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
Slices for identifier	SOΣC	1..1	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
identifier:ihi	SOΣ	0..1	AUIHI	Identifies this patient across multiple systems Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
identifier:medicare	SOΣ	0..1	AUMedicareCardNumber	Identifies this patient across multiple systems Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
identifier:dva	SOΣ	0..1	AUDVANumber	Identifies this patient across multiple systems Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SOΣC	1..*	HumanName	A name associated with the patient Constraints: au-core-pat-03 Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
use	?!SOΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
text	SOΣ	0..1	string	Text representation of the full name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
family	SOΣ	1..1	string	Family name (often called 'Surname') Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
given	SOΣ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
telecom	SOΣ	0..*	ContactPoint	A contact detail for the individual Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
gender	SOΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
birthDate	SOΣC	1..1	date	Date of birth extended for time and accuracy indicator Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
Slices for extension				Content/Rules for all slices
extension:accuracyIndicator		0..1	Coding	Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
extension:birthTime	C	0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Deceased indicator
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Deceased date time
Slices for extension				Content/Rules for all slices
extension:accuracyIndicator		0..1	Coding	Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
address	SOΣ	0..*	AustralianAddress, Address	An address for the individual Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
communication	SO	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	SO	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) Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
preferred	SO	0..1	boolean	Language preference indicator Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
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	Status	Usage	ValueSet	Version	Source
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	extensible	Common Languages in Australia	⏿2.2.1	tx.ontoserver.csiro.au
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
au-core-pat-01	error	Patient	At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present	(identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
au-core-pat-02	error	Patient	At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present	name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
au-core-pat-03	error	Patient.name	At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present	(text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
inv-pat-0	error	Patient	If present, birth time's date shall be the birth date	birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString()
inv-pat-1	warning	Patient	Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-pat-2	warning	Patient	Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-pat-3	warning	Patient	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-pat-4	warning	Patient	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-pat-5	warning	Patient	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))

Differential View

This structure is derived from AUCorePatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	AUCorePatient	A patient in the context of electronic exchange of health information
identifier		1..1	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems
name
family		1..1	string	Family name (often called 'Surname')
given		1..*	string	Given names (not always 'first'). Includes middle names
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	AUCorePatient	A patient in the context of electronic exchange of health information Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, au-core-pat-01, au-core-pat-02
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:indigenousStatus	SO	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
extension:veteranStatus		0..*	Coding	Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
extension:closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
extension:mothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
extension:interpreterRequired		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension:dateOfArrival		0..1	date	The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
extension:genderIdentity	SOC	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 Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
extension:individualPronouns	SOC	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 Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
extension: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
Slices for identifier	SOΣC	1..1	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
identifier:ihi	SOΣ	0..1	AUIHI	Identifies this patient across multiple systems Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
identifier:medicare	SOΣ	0..1	AUMedicareCardNumber	Identifies this patient across multiple systems Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
identifier:dva	SOΣ	0..1	AUDVANumber	Identifies this patient across multiple systems Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SOΣC	1..*	HumanName	A name associated with the patient Constraints: au-core-pat-03 Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SOΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
text	SOΣ	0..1	string	Text representation of the full name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
family	SOΣ	1..1	string	Family name (often called 'Surname') Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
given	SOΣ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SOΣ	0..*	ContactPoint	A contact detail for the individual Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
gender	SOΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
birthDate	SOΣC	1..1	date	Date of birth extended for time and accuracy indicator Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:accuracyIndicator		0..1	Coding	Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding
extension:birthTime	C	0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
value		0..1	date	Primitive value for date
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Deceased indicator
deceased[x]:deceasedDateTime	?!Σ	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
extension:accuracyIndicator		0..1	Coding	Deceased 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	SOΣ	0..*	AustralianAddress, Address	An address for the individual Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
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		0..*	CodeableConcept	The kind of relationship Binding: Contact Relationship Type (extensible)
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address, AustralianAddress	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(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	SO	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
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	SO	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) Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
preferred	SO	0..1	boolean	Language preference indicator Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Patient SHALL:no-error AU Core Requester from AU Core Patient
generalPractitioner		0..*	Reference(Organization | Practitioner | 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	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	MaritalStatus	📦4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Contact Relationship Type	⏿3.1.0	tx.ontoserver.csiro.au
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	extensible	Common Languages in Australia	⏿2.2.1	tx.ontoserver.csiro.au
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
au-core-pat-01	error	Patient	At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present	(identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
au-core-pat-02	error	Patient	At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present	name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
au-core-pat-03	error	Patient.name	At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present	(text.exists() or family.exists() or given.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
inv-pat-0	error	Patient	If present, birth time's date shall be the birth date	birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').exists() implies birthDate.extension('http://hl7.org/fhir/StructureDefinition/patient-birthTime').value.toString().substring(0,10) = birthDate.toString()
inv-pat-1	warning	Patient	Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-pat-2	warning	Patient	Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-pat-3	warning	Patient	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-pat-4	warning	Patient	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-pat-5	warning	Patient	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from AUCorePatient

Summary

Mandatory: 2 elements

Other representations of profile: CSV, Excel, Schematron