See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.

Profile Specific Implementation Guidance

• See the guidance on implementing the Patient resource in AU Core.
• When populating Patient.identifier, producers are not required to populate all known patient identifiers from the source system. Producers:
  • SHALL populate with at least one identifier
  • SHALL populate with at least one of the supported identifier types if known
  • SHOULD populate an IHI in preference to Medicare or DVA numbers where the IHI is known and MAY also provide a Medicare, DVA number, other identifier type or any combination of them
• This profile supports the sex, gender, and related concepts of: Name to Use, Gender Identity, and Individual Pronouns. See the Sex and Gender page for guidance on exchanging sex and gender related concepts conformant to AU PS.

Examples for this Profile: Bundle/aups-basicsummary, Bundle/aups-gpvisit-retrieval, Bundle/aups-noknownx, Bundle/aups-patient-story, Bundle/aups-referral-endoconsult-autogen, Bundle/aups-referral-endoconsult-curated and Bundle/aups-section-emptyreason

• 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 This profile also complies with the profile Patient (IPS) Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, inv-pat-6, au-core-pat-01, au-core-pat-02
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:indigenousStatus	SO This element has obligations and must be supported.	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.extension:veteranStatus		0..*	Coding	Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
Patient.Slices for extension.extension:closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
Patient.Slices for extension.extension:mothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
Patient.Slices for extension.extension:interpreterRequired		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.Slices for extension.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
Patient.Slices for extension.extension:genderIdentity	SO This element has obligations and must be supported. C	0..*	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.extension:individualPronouns	SO This element has obligations and must be supported. C	0..*	(Complex)	The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.Slices for extension.extension:sexParameterForClinicalUse		0..*	(Complex)	A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..*	Identifier , AUIHI , AUMedicareCardNumber , AUDVANumber , AUHealthCareCardNumber , AUPensionerConcessionCardNumber , AUCwlthSeniorsHealthCardNumber , AUMedicalRecordNumber , AUInsuranceMemberNumber , AUPatientInternalIdentifier	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:ihi	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	AUIHI	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for identifier.identifier:medicare	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	AUMedicareCardNumber	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for identifier.identifier:dva	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	AUDVANumber	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..*	HumanName	A name associated with the patient Constraints: au-core-pat-03, ips-pat-1 Obligations Actor SHALL:populate AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.use	?! This element is a modifier element. SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.text	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name Obligations Actor SHALL:populate-if-known AU PS Producer SHOULD:able-to-populate AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.family	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.given	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	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 SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.telecom	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the individual Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.telecom.system	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.telecom.value	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.telecom.use	?! This element is a modifier element. SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.gender	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.birthDate	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..1	date	Date of birth extended for time and accuracy indicator Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.birthDate.Slices for extension				Content/Rules for all slices
Patient.birthDate.Slices for extension.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
Patient.birthDate.Slices for extension.extension:birthTime	C	0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
Patient.Slices for deceased[x].deceasedBoolean			boolean
Patient.Slices for deceased[x].deceasedDateTime			dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Deceased indicator
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Deceased date time
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.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
Patient.address	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	AustralianAddress , Address	An address for the individual Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication	SO This element has obligations and must be supported.	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language	SO This element has obligations and must be supported.	1..1	CodeableConceptIPS	The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication.preferred	SO This element has obligations and must be supported.	0..1	boolean	Language preference indicator Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.generalPractitioner	SO This element has obligations and must be supported.	0..*	Reference(AU PS Organization | AU PS Practitioner | AU PS PractitionerRole)	Patient's nominated primary care provider Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual person
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	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.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍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.hl7.org.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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(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').extension('value').value.all(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').extension('type').value.all(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').extension('sourceDocument').value.ofType(CodeableConcept).all(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').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-pat-6	warning	Patient	Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present	family.exists() or given.exists() or text.exists()

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 This profile also complies with the profile Patient (IPS)
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:indigenousStatus	O This element has obligations.	0..1	AustralianIndigenousStatus	Indigenous status Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.extension:genderIdentity	O This element has obligations.	0..*	PGenderIdentity(5.3.0)	The individual's gender identity Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.extension:individualPronouns	O This element has obligations.	0..*	Pronouns(5.3.0)	The pronouns to use when communicating about an individual. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.identifier	O This element has obligations.	1..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for identifier				Content/Rules for all slices
Patient.Slices for identifier.identifier:ihi	O This element has obligations.	0..1	AUIHI	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for identifier.identifier:medicare	O This element has obligations.	0..*	AUMedicareCardNumber	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for identifier.identifier:dva	O This element has obligations.	0..1	AUDVANumber	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name	O This element has obligations. C	1..*	HumanName	A name associated with the patient Constraints: ips-pat-1 Obligations Actor SHALL:populate AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.use	O This element has obligations.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.text	O This element has obligations.	0..1	string	Text representation of the full name Obligations Actor SHALL:populate-if-known AU PS Producer SHOULD:able-to-populate AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.family	O This element has obligations.	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.given	O This element has obligations.	0..*	string	Given names (not always 'first'). Includes middle names Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.telecom	O This element has obligations.	0..*	ContactPoint	A contact detail for the individual Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.telecom.system	O This element has obligations.	0..1	code	phone | fax | email | pager | url | sms | other Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.telecom.value	O This element has obligations.	0..1	string	The actual contact point details Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.telecom.use	O This element has obligations.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.gender	O This element has obligations.	1..1	code	male | female | other | unknown Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.birthDate	O This element has obligations.	1..1	date	Date of birth extended for time and accuracy indicator Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.address	O This element has obligations.	0..*	AustralianAddress, Address	An address for the individual Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication	O This element has obligations.	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication.language	O This element has obligations.	1..1	CodeableConceptIPS	The language which can be used to communicate with the patient about his or her health Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication.preferred	O This element has obligations.	0..1	boolean	Language preference indicator Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.generalPractitioner	SO This element has obligations and must be supported.	0..*	Reference(AU PS Organization | AU PS Practitioner | AU PS PractitionerRole)	Patient's nominated primary care provider Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present	family.exists() or given.exists() or text.exists()

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 This profile also complies with the profile Patient (IPS) Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, inv-pat-6, au-core-pat-01, au-core-pat-02
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.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
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:indigenousStatus	SO This element has obligations and must be supported.	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.extension:veteranStatus		0..*	Coding	Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
Patient.Slices for extension.extension:closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
Patient.Slices for extension.extension:mothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
Patient.Slices for extension.extension:interpreterRequired		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.Slices for extension.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
Patient.Slices for extension.extension:genderIdentity	SO This element has obligations and must be supported. C	0..*	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.extension:individualPronouns	SO This element has obligations and must be supported. C	0..*	(Complex)	The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.Slices for extension.extension:sexParameterForClinicalUse		0..*	(Complex)	A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..*	Identifier , AUIHI , AUMedicareCardNumber , AUDVANumber , AUHealthCareCardNumber , AUPensionerConcessionCardNumber , AUCwlthSeniorsHealthCardNumber , AUMedicalRecordNumber , AUInsuranceMemberNumber , AUPatientInternalIdentifier	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:ihi	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	AUIHI	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for identifier.identifier:medicare	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	AUMedicareCardNumber	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for identifier.identifier:dva	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	AUDVANumber	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..*	HumanName	A name associated with the patient Constraints: au-core-pat-03, ips-pat-1 Obligations Actor SHALL:populate AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.id		0..1	string	Unique id for inter-element referencing
Patient.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.name.use	?! This element is a modifier element. SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.text	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name Obligations Actor SHALL:populate-if-known AU PS Producer SHOULD:able-to-populate AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.family	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.given	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	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 SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.telecom	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the individual Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.telecom.id		0..1	string	Unique id for inter-element referencing
Patient.telecom.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.telecom.system	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.telecom.value	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.telecom.use	?! This element is a modifier element. SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Patient.telecom.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Patient.gender	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.birthDate	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..1	date	Date of birth extended for time and accuracy indicator Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.birthDate.id		0..1	string	xml:id (or equivalent in JSON)
Patient.birthDate.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.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
Patient.birthDate.Slices for extension.extension:birthTime	C	0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.value		0..1	date	Primitive value for date
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
Patient.Slices for deceased[x].deceasedBoolean			boolean
Patient.Slices for deceased[x].deceasedDateTime			dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Deceased indicator
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Deceased date time
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.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
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.value		0..1	dateTime	Primitive value for dateTime
Patient.address	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	AustralianAddress , Address	An address for the individual Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: Contact Relationship Type (extensible)
Patient.contact.name		0..1	HumanName	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address , AustralianAddress	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication	SO This element has obligations and must be supported.	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language	SO This element has obligations and must be supported.	1..1	CodeableConceptIPS	The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication.preferred	SO This element has obligations and must be supported.	0..1	boolean	Language preference indicator Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.generalPractitioner	SO This element has obligations and must be supported.	0..*	Reference(AU PS Organization | AU PS Practitioner | AU PS PractitionerRole)	Patient's nominated primary care provider Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual person
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	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.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍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.hl7.org.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.hl7.org.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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(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').extension('value').value.all(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').extension('type').value.all(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').extension('sourceDocument').value.ofType(CodeableConcept).all(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').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-pat-6	warning	Patient	Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present	family.exists() or given.exists() or text.exists()
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()

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 This profile also complies with the profile Patient (IPS) Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, inv-pat-6, au-core-pat-01, au-core-pat-02
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:indigenousStatus	SO This element has obligations and must be supported.	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.extension:veteranStatus		0..*	Coding	Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
Patient.Slices for extension.extension:closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
Patient.Slices for extension.extension:mothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
Patient.Slices for extension.extension:interpreterRequired		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.Slices for extension.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
Patient.Slices for extension.extension:genderIdentity	SO This element has obligations and must be supported. C	0..*	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.extension:individualPronouns	SO This element has obligations and must be supported. C	0..*	(Complex)	The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.Slices for extension.extension:sexParameterForClinicalUse		0..*	(Complex)	A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..*	Identifier , AUIHI , AUMedicareCardNumber , AUDVANumber , AUHealthCareCardNumber , AUPensionerConcessionCardNumber , AUCwlthSeniorsHealthCardNumber , AUMedicalRecordNumber , AUInsuranceMemberNumber , AUPatientInternalIdentifier	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:ihi	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	AUIHI	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for identifier.identifier:medicare	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	AUMedicareCardNumber	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for identifier.identifier:dva	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	AUDVANumber	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..*	HumanName	A name associated with the patient Constraints: au-core-pat-03, ips-pat-1 Obligations Actor SHALL:populate AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.use	?! This element is a modifier element. SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.text	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name Obligations Actor SHALL:populate-if-known AU PS Producer SHOULD:able-to-populate AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.family	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.given	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	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 SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.telecom	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the individual Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.telecom.system	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.telecom.value	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.telecom.use	?! This element is a modifier element. SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.gender	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.birthDate	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..1	date	Date of birth extended for time and accuracy indicator Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.birthDate.Slices for extension				Content/Rules for all slices
Patient.birthDate.Slices for extension.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
Patient.birthDate.Slices for extension.extension:birthTime	C	0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
Patient.Slices for deceased[x].deceasedBoolean			boolean
Patient.Slices for deceased[x].deceasedDateTime			dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Deceased indicator
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Deceased date time
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.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
Patient.address	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	AustralianAddress , Address	An address for the individual Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication	SO This element has obligations and must be supported.	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language	SO This element has obligations and must be supported.	1..1	CodeableConceptIPS	The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication.preferred	SO This element has obligations and must be supported.	0..1	boolean	Language preference indicator Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.generalPractitioner	SO This element has obligations and must be supported.	0..*	Reference(AU PS Organization | AU PS Practitioner | AU PS PractitionerRole)	Patient's nominated primary care provider Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual person
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	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.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍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.hl7.org.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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(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').extension('value').value.all(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').extension('type').value.all(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').extension('sourceDocument').value.ofType(CodeableConcept).all(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').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-pat-6	warning	Patient	Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present	family.exists() or given.exists() or text.exists()

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 This profile also complies with the profile Patient (IPS)
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:indigenousStatus	O This element has obligations.	0..1	AustralianIndigenousStatus	Indigenous status Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.extension:genderIdentity	O This element has obligations.	0..*	PGenderIdentity(5.3.0)	The individual's gender identity Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.extension:individualPronouns	O This element has obligations.	0..*	Pronouns(5.3.0)	The pronouns to use when communicating about an individual. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.identifier	O This element has obligations.	1..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber, AUPatientInternalIdentifier	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for identifier				Content/Rules for all slices
Patient.Slices for identifier.identifier:ihi	O This element has obligations.	0..1	AUIHI	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for identifier.identifier:medicare	O This element has obligations.	0..*	AUMedicareCardNumber	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for identifier.identifier:dva	O This element has obligations.	0..1	AUDVANumber	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name	O This element has obligations. C	1..*	HumanName	A name associated with the patient Constraints: ips-pat-1 Obligations Actor SHALL:populate AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.use	O This element has obligations.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.text	O This element has obligations.	0..1	string	Text representation of the full name Obligations Actor SHALL:populate-if-known AU PS Producer SHOULD:able-to-populate AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.family	O This element has obligations.	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.given	O This element has obligations.	0..*	string	Given names (not always 'first'). Includes middle names Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.telecom	O This element has obligations.	0..*	ContactPoint	A contact detail for the individual Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.telecom.system	O This element has obligations.	0..1	code	phone | fax | email | pager | url | sms | other Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.telecom.value	O This element has obligations.	0..1	string	The actual contact point details Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.telecom.use	O This element has obligations.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.gender	O This element has obligations.	1..1	code	male | female | other | unknown Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.birthDate	O This element has obligations.	1..1	date	Date of birth extended for time and accuracy indicator Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.address	O This element has obligations.	0..*	AustralianAddress, Address	An address for the individual Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication	O This element has obligations.	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication.language	O This element has obligations.	1..1	CodeableConceptIPS	The language which can be used to communicate with the patient about his or her health Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication.preferred	O This element has obligations.	0..1	boolean	Language preference indicator Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.generalPractitioner	SO This element has obligations and must be supported.	0..*	Reference(AU PS Organization | AU PS Practitioner | AU PS PractitionerRole)	Patient's nominated primary care provider Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present	family.exists() or given.exists() or text.exists()

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 This profile also complies with the profile Patient (IPS) Constraints: inv-pat-0, inv-pat-1, inv-pat-2, inv-pat-3, inv-pat-4, inv-pat-5, inv-pat-6, au-core-pat-01, au-core-pat-02
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.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
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:indigenousStatus	SO This element has obligations and must be supported.	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.extension:veteranStatus		0..*	Coding	Veteran / Australian Defence Force (ADF) status URL: http://hl7.org.au/fhir/StructureDefinition/veteran-status Binding: Australian Veteran Status (required)
Patient.Slices for extension.extension:closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
Patient.Slices for extension.extension:mothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
Patient.Slices for extension.extension:interpreterRequired		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.Slices for extension.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
Patient.Slices for extension.extension:genderIdentity	SO This element has obligations and must be supported. C	0..*	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.extension:individualPronouns	SO This element has obligations and must be supported. C	0..*	(Complex)	The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for extension.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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.Slices for extension.extension:sexParameterForClinicalUse		0..*	(Complex)	A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..*	Identifier , AUIHI , AUMedicareCardNumber , AUDVANumber , AUHealthCareCardNumber , AUPensionerConcessionCardNumber , AUCwlthSeniorsHealthCardNumber , AUMedicalRecordNumber , AUInsuranceMemberNumber , AUPatientInternalIdentifier	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:ihi	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	AUIHI	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for identifier.identifier:medicare	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	AUMedicareCardNumber	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.Slices for identifier.identifier:dva	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	AUDVANumber	Identifies this patient across multiple systems Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..*	HumanName	A name associated with the patient Constraints: au-core-pat-03, ips-pat-1 Obligations Actor SHALL:populate AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.id		0..1	string	Unique id for inter-element referencing
Patient.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.name.use	?! This element is a modifier element. SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.text	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name Obligations Actor SHALL:populate-if-known AU PS Producer SHOULD:able-to-populate AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.family	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.given	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	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 SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.name.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.telecom	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the individual Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.telecom.id		0..1	string	Unique id for inter-element referencing
Patient.telecom.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.telecom.system	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.telecom.value	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.telecom.use	?! This element is a modifier element. SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
Patient.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Patient.telecom.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Patient.gender	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.birthDate	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..1	date	Date of birth extended for time and accuracy indicator Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.birthDate.id		0..1	string	xml:id (or equivalent in JSON)
Patient.birthDate.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.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
Patient.birthDate.Slices for extension.extension:birthTime	C	0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.value		0..1	date	Primitive value for date
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
Patient.Slices for deceased[x].deceasedBoolean			boolean
Patient.Slices for deceased[x].deceasedDateTime			dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Deceased indicator
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Deceased date time
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.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
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.value		0..1	dateTime	Primitive value for dateTime
Patient.address	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	AustralianAddress , Address	An address for the individual Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: Contact Relationship Type (extensible)
Patient.contact.name		0..1	HumanName	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address , AustralianAddress	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication	SO This element has obligations and must be supported.	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language	SO This element has obligations and must be supported.	1..1	CodeableConceptIPS	The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.communication.preferred	SO This element has obligations and must be supported.	0..1	boolean	Language preference indicator Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.generalPractitioner	SO This element has obligations and must be supported.	0..*	Reference(AU PS Organization | AU PS Practitioner | AU PS PractitionerRole)	Patient's nominated primary care provider Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual person
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	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.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍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.hl7.org.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.hl7.org.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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(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').extension('value').value.all(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').extension('type').value.all(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').extension('sourceDocument').value.ofType(CodeableConcept).all(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').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-pat-6	warning	Patient	Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present	family.exists() or given.exists() or text.exists()
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

Must-Support: 1 element

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• AU PS Organization (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-organization)
• AU PS Practitioner (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitioner)
• AU PS PractitionerRole (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitionerrole)

Maturity: 2