HL7.FHIR.AU.BASE\AU Base Patient

AU Base Implementation Guide
4.1.0 - Trial Use Australia flag

This page is part of the AU Base Implementation Guide 4.1.0. It is based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Base Patient

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-patient		Version: 4.1.0
Standards status: Trial-use	Maturity Level: 3	Computable Name: AUBasePatient
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines a patient structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Usage Notes

Profile specific implementation guidance:

This profile supports patient gender identity aligned to Australian Bureau of Statics Standard for Sex, Gender, Variations of Sex Characteristics and Sexual Orientation Variables, 2020 using the genderIdentity extension and Gender Identity Response value set.
- Man or male may be represented by sending the SNOMED CT code 446151000124109|Identifies as male gender|
- Woman or female may be represented by sending the SNOMED CT code 446141000124107|Identifies as female gender|
- Non-binary may be represented by sending the SNOMED CT code 33791000087105|Identifies as nonbinary gender|, see example Patient/example4
- [I/They] use a different term (please specify) may be represented by sending only text and no code, see example Patient/example7
- Prefer not to answer may be represented by sending the code “asked-declined”, see example Patient/example0
- Not stated or inadequately described may be represented by the code “unknown”
Need for an interpreter service can be represented with the interpreterRequired extension set to “true”
- If the language for interpreter service is known, the language is included in Patient.communication.language and Patient.communication.preferred is set to “true”.
- If Patient.communication.preferred has not been included, or is set to “false”, systems should understand this as the language for the interpreter service is not known.
See each Identifier profile page for guidance related to that identifier type.

Extensions under consideration:

Patient: Ethnicity

Usage:

Examples for this Resource Profile: Patient/example0, Patient/example1, Patient/example2, Patient/example3, Patient/example4, Patient/example5, Patient/example6, Patient/example7, Patient/example8

Formal Views of Profile Content

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

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	Patient	A patient in an Australian healthcare context inv-pat-0: If present, birth time's date shall be the birth date
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
indigenousStatus		0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
mothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
interpreterRequired		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
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
genderIdentity		0..1	CodeableConcept	The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example)
valueCodeableConcept		1..1	CodeableConcept	Value of extension Binding: https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 (extensible)
identifier		0..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems
birthDate		0..1	date	Date of birth extended for time and accuracy indicator
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
accuracyIndicator		0..1	Coding	Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding
birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Slices for deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedBoolean		0..1	boolean	Deceased indicator
deceased[x]:deceasedDateTime		0..1	dateTime	Deceased date time
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
accuracyIndicator		0..1	Coding	Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding
address		0..*	AustralianAddress, Address	An address for the individual
contact
relationship		0..*	CodeableConcept	The kind of relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible)
address		0..1	Address, AustralianAddress	Address for the contact person
communication
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
link		0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual person
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Patient.extension:genderIdentity.valueCodeableConcept	extensible	https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1
Patient.contact.relationship	extensible	https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3
Patient.communication.language	extensible	https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	Patient	A patient in an Australian healthcare context inv-pat-0: If present, birth time's date shall be the birth date
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
indigenousStatus		0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
mothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
interpreterRequired		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
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
genderIdentity		0..1	CodeableConcept	The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example)
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-genderIdentity"
Slices for value[x]		1..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example)
value[x]:valueCodeableConcept		1..1	CodeableConcept	Value of extension Binding: https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
birthDate	Σ	0..1	date	Date of birth extended for time and accuracy indicator
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
accuracyIndicator		0..1	Coding	Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding
birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Deceased indicator
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Deceased date time
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
accuracyIndicator		0..1	Coding	Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding
address	C	0..*	AustralianAddress, Address	An address for the individual
link	?!Σ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient \| RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by \| replaces \| refer \| seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Patient.extension:genderIdentity.value[x]	example	GenderIdentity
Patient.extension:genderIdentity.value[x]:valueCodeableConcept	extensible	https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1
Patient.link.type	required	LinkType

Constraints

Id	Grade	Path(s)	Details	Requirements
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-add-0	error	Patient.address	The address shall at least have text or a line : text.exists() or line.exists()
inv-add-1	error	Patient.address	If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
inv-add-2	error	Patient.address	If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
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()

Description & Constraints

Patient

C

0..*

Patient

A patient in an Australian healthcare context
inv-pat-0: If present, birth time's date shall be the birth date

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path

Conformance

ValueSet

Patient.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

Patient.extension:genderIdentity.value[x]

example

GenderIdentity

Patient.extension:genderIdentity.value[x]:valueCodeableConcept

extensible

https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1

Patient.gender

required

AdministrativeGender

Patient.maritalStatus

extensible

Marital Status Codes

Patient.contact.relationship

extensible

https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3

Patient.contact.gender

required

AdministrativeGender

Patient.communication.language

extensible

https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Patient.link.type

required

LinkType

Constraints

Id	Grade	Path(s)	Details	Requirements
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-add-0	error	Patient.address	The address shall at least have text or a line : text.exists() or line.exists()
inv-add-1	error	Patient.address	If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
inv-add-2	error	Patient.address	If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
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 Patient

Summary

Structures

This structure refers to these other structures:

Australian Address (http://hl7.org.au/fhir/StructureDefinition/au-address)

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

The element Patient.deceased[x] is sliced based on the value of type:$this (Closed)

Maturity: 3

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	Patient	A patient in an Australian healthcare context inv-pat-0: If present, birth time's date shall be the birth date
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
indigenousStatus		0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
mothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
interpreterRequired		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
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
genderIdentity		0..1	CodeableConcept	The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example)
valueCodeableConcept		1..1	CodeableConcept	Value of extension Binding: https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 (extensible)
identifier		0..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems
birthDate		0..1	date	Date of birth extended for time and accuracy indicator
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
accuracyIndicator		0..1	Coding	Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding
birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Slices for deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedBoolean		0..1	boolean	Deceased indicator
deceased[x]:deceasedDateTime		0..1	dateTime	Deceased date time
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
accuracyIndicator		0..1	Coding	Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding
address		0..*	AustralianAddress, Address	An address for the individual
contact
relationship		0..*	CodeableConcept	The kind of relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 (extensible)
address		0..1	Address, AustralianAddress	Address for the contact person
communication
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
link		0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual person
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Patient.extension:genderIdentity.valueCodeableConcept	extensible	https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1
Patient.contact.relationship	extensible	https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3
Patient.communication.language	extensible	https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	Patient	A patient in an Australian healthcare context inv-pat-0: If present, birth time's date shall be the birth date
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
indigenousStatus		0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-indigenous-status-1 (required)
closingTheGapRegistration		0..1	boolean	Closing the Gap co-payment eligibility indicator URL: http://hl7.org.au/fhir/StructureDefinition/closing-the-gap-registration
mothersMaidenName		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
interpreterRequired		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
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
genderIdentity		0..1	CodeableConcept	The patient's gender identity shall be a member of the Gender Identity Response value set if any of the codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example)
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-genderIdentity"
Slices for value[x]		1..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example)
value[x]:valueCodeableConcept		1..1	CodeableConcept	Value of extension Binding: https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	Identifies this patient across multiple systems
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
birthDate	Σ	0..1	date	Date of birth extended for time and accuracy indicator
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
accuracyIndicator		0..1	Coding	Birth date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding
birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Deceased indicator
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Deceased date time
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
accuracyIndicator		0..1	Coding	Deceased date accuracy indicator URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator Binding: https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 (required): Date accuracy coding
address	C	0..*	AustralianAddress, Address	An address for the individual
link	?!Σ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient \| RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by \| replaces \| refer \| seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Patient.extension:genderIdentity.value[x]	example	GenderIdentity
Patient.extension:genderIdentity.value[x]:valueCodeableConcept	extensible	https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1
Patient.link.type	required	LinkType

Constraints

Id	Grade	Path(s)	Details	Requirements
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-add-0	error	Patient.address	The address shall at least have text or a line : text.exists() or line.exists()
inv-add-1	error	Patient.address	If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
inv-add-2	error	Patient.address	If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
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()

Snapshot View

Description & Constraints

Patient

C

0..*

Patient

A patient in an Australian healthcare context
inv-pat-0: If present, birth time's date shall be the birth date

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path

Conformance

ValueSet

Patient.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

Patient.extension:genderIdentity.value[x]

example

GenderIdentity

Patient.extension:genderIdentity.value[x]:valueCodeableConcept

extensible

https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1

Patient.gender

required

AdministrativeGender

Patient.maritalStatus

extensible

Marital Status Codes

Patient.contact.relationship

extensible

https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3

Patient.contact.gender

required

AdministrativeGender

Patient.communication.language

extensible

https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Patient.link.type

required

LinkType

Constraints

Id	Grade	Path(s)	Details	Requirements
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-add-0	error	Patient.address	The address shall at least have text or a line : text.exists() or line.exists()
inv-add-1	error	Patient.address	If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'
inv-add-2	error	Patient.address	If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')
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()