Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	AUBasePatient	A patient in an Australian healthcare context Constraints: inv-pat-0
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:indigenousStatus	S	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
extension:sexAtBirth	S	1..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:patientRegistrationStatus	S	0..1	(Complex)	Patient registration status (Medtech – required) URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status
extension		0..0
url		1..1	uri	"https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status"
value[x]		0..1	CodeableConcept	Value of extension Binding: Medtech Patient Registration ValueSet (extensible)
extension:patientLocation	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-location
extension:patientEthnicity	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-ethnicity Binding: Medtech Patient Ethnicity ValueSet (required)
extension:isAccountHolder	S	0..1	boolean	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acholder
extension:accountGroup	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-account-group Binding: Medtech Patient Account Group ValueSet (required)
extension:accountHeldBy	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acheldby
extension:countryOfBirth	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/country-of-birth Binding: Medtech Country of Birth ValueSet (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SC	0..*	AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
identifier:ihi	S	0..*	AUIHI	Identifies this patient across multiple systems
identifier:medicare	S	0..*	AUMedicareCardNumber	Identifies this patient across multiple systems
identifier:dva	S	0..*	AUDVANumber	Identifies this patient across multiple systems
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: The DVA Entitlement for Patient (required)
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/dva
value	Σ	1..1	string	DVA number Example General: 123456 Example DVA number: NBUR9080 Max Length:9
identifier:healthcare	S	0..1	AUHealthCareCardNumber	Identifies this patient across multiple systems
identifier:pen	S	0..1	AUPensionerConcessionCardNumber	Identifies this patient across multiple systems
identifier:sen	S	0..1	AUCwlthSeniorsHealthCardNumber	Identifies this patient across multiple systems
identifier:mrn	S	0..*	AUMedicalRecordNumber	Identifies this patient across multiple systems
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
Slices for name	Σ	1..2	HumanName	A name associated with the patient Slice: Unordered, Open by value:use
name:official	SΣ	1..1	HumanName	A name associated with the patient
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
name:preferred	SΣ	0..1	HumanName	A name associated with the patient
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: usual
given	SΣ	1..1	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
birthDate	SΣ	1..1	date	Date of birth extended for time and accuracy indicator
Slices for extension				Content/Rules for all slices
address	SC	0..2	AlexAddress	An address for the individual Constraints: inv-add-0, inv-add-1, inv-add-2
maritalStatus	S	0..1	CodeableConcept	Patient marital status (Medtech – required) Binding: Medtech Marital Status ValueSet (extensible)
contact	SC	0..2	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
generalPractitioner	S	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.extension:genderIdentity.​value[x]	Base	example	Gender identity	📦4.0.1	FHIR Std.
Patient.extension:genderIdentity.​value[x]:valueCodeableConcept	Base	extensible	Gender Identity Response	⏿1.1.0	tx.ontoserver.csiro.au
Patient.extension:patientRegistrationStatus.​value[x]	Base	extensible	Medtech Patient Registration ValueSet	📦1.0.0	This IG
Patient.identifier:dva.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:dva.​type	Base	required	The DVA Entitlement for Patient	📦1.0.0	This IG
Patient.name:official.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name:preferred.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	Medtech Marital Status ValueSet	📦1.0.0	This IG
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()
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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			AUBasePatient
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:birthPlace		0..0
extension:indigenousStatus	S	0..1	AustralianIndigenousStatus	Indigenous status
extension:closingTheGapRegistration		0..0
extension:mothersMaidenName		0..0
extension:interpreterRequired		0..0
extension:dateOfArrival		0..0
extension:genderIdentity		0..0
extension:sexAtBirth	S	1..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:patientRegistrationStatus	S	0..1	(Complex)	Patient registration status (Medtech – required) URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status
value[x]		0..1	CodeableConcept	Value of extension
extension:patientLocation	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-location
extension:patientEthnicity	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-ethnicity Binding: Medtech Patient Ethnicity ValueSet (required)
extension:isAccountHolder	S	0..1	boolean	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acholder
extension:accountGroup	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-account-group Binding: Medtech Patient Account Group ValueSet (required)
extension:accountHeldBy	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acheldby
extension:countryOfBirth	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/country-of-birth Binding: Medtech Country of Birth ValueSet (extensible)
Slices for identifier	SC	0..*	AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
identifier:ihi	S	0..*	AUIHI	Identifies this patient across multiple systems
identifier:medicare	S	0..*	AUMedicareCardNumber	Identifies this patient across multiple systems
identifier:dva	S	0..*	AUDVANumber	Identifies this patient across multiple systems
type		1..1	CodeableConcept	Description of identifier Binding: The DVA Entitlement for Patient (required)
identifier:healthcare	S	0..1	AUHealthCareCardNumber	Identifies this patient across multiple systems
identifier:pen	S	0..1	AUPensionerConcessionCardNumber	Identifies this patient across multiple systems
identifier:sen	S	0..1	AUCwlthSeniorsHealthCardNumber	Identifies this patient across multiple systems
identifier:mrn	S	0..*	AUMedicalRecordNumber	Identifies this patient across multiple systems
Slices for name		1..2	HumanName	A name associated with the patient Slice: Unordered, Open by value:use
name:official	S	1..1	HumanName	A name associated with the patient
use		1..1	code	usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official
family	S	1..1	string	Family name (often called 'Surname')
given	S	1..*	string	Given names (not always 'first'). Includes middle names
prefix	S	0..1	string	Parts that come before the name
name:preferred	S	0..1	HumanName	A name associated with the patient
use		1..1	code	usual | official | temp | nickname | anonymous | old | maiden Required Pattern: usual
family	S	0..0
given	S	1..1	string	Given names (not always 'first'). Includes middle names
prefix	S	0..1	string	Parts that come before the name
telecom	S	0..*	ContactPoint	A contact detail for the individual
birthDate	S	1..1	date	Date of birth extended for time and accuracy indicator
Slices for extension				Content/Rules for all slices
extension:accuracyIndicator		0..0
extension:birthTime		0..0
deceased[x]		0..0
Slices for deceased[x]				Content/Rules for all slices
deceased[x]:deceasedBoolean		0..0
deceased[x]:deceasedDateTime		0..0
address	S	0..2	AlexAddress	An address for the individual
maritalStatus	S	0..1	CodeableConcept	Patient marital status (Medtech – required) Binding: Medtech Marital Status ValueSet (extensible)
coding
system		0..1	uri	Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/marital-status
multipleBirth[x]		0..0
photo		0..0
contact	S	0..2	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
generalPractitioner	S	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
link		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier:dva.​type	Base	required	The DVA Entitlement for Patient	📦1.0.0	This IG
Patient.maritalStatus	Base	extensible	Medtech Marital Status ValueSet	📦1.0.0	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	AUBasePatient	A patient in an Australian healthcare context Constraints: inv-pat-0
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:indigenousStatus	S	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
extension:sexAtBirth	S	1..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:patientRegistrationStatus	S	0..1	(Complex)	Patient registration status (Medtech – required) URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status"
value[x]		0..1	CodeableConcept	Value of extension Binding: Medtech Patient Registration ValueSet (extensible)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/registration-status-code
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
extension:patientLocation	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-location
extension:patientEthnicity	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-ethnicity Binding: Medtech Patient Ethnicity ValueSet (required)
extension:isAccountHolder	S	0..1	boolean	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acholder
extension:accountGroup	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-account-group Binding: Medtech Patient Account Group ValueSet (required)
extension:accountHeldBy	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acheldby
extension:countryOfBirth	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/country-of-birth Binding: Medtech Country of Birth ValueSet (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SC	0..*	AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
identifier:ihi	S	0..*	AUIHI	Identifies this patient across multiple systems
identifier:medicare	S	0..*	AUMedicareCardNumber	Identifies this patient across multiple systems
identifier:dva	S	0..*	AUDVANumber	Identifies this patient across multiple systems
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: The DVA Entitlement for Patient (required)
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/dva
value	Σ	1..1	string	DVA number Example General: 123456 Example DVA number: NBUR9080 Max Length:9
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:healthcare	S	0..1	AUHealthCareCardNumber	Identifies this patient across multiple systems
identifier:pen	S	0..1	AUPensionerConcessionCardNumber	Identifies this patient across multiple systems
identifier:sen	S	0..1	AUCwlthSeniorsHealthCardNumber	Identifies this patient across multiple systems
identifier:mrn	S	0..*	AUMedicalRecordNumber	Identifies this patient across multiple systems
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
Slices for name	Σ	1..2	HumanName	A name associated with the patient Slice: Unordered, Open by value:use
name:official	SΣ	1..1	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official
text	Σ	0..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
name:preferred	SΣ	0..1	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: usual
text	Σ	0..1	string	Text representation of the full name
given	SΣ	1..1	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	Date of birth extended for time and accuracy indicator
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
value		0..1	date	Primitive value for date
address	SC	0..2	AlexAddress	An address for the individual Constraints: inv-add-0, inv-add-1, inv-add-2
maritalStatus	S	0..1	CodeableConcept	Patient marital status (Medtech – required) Binding: Medtech Marital Status ValueSet (extensible)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/marital-status
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
contact	SC	0..2	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: Contact Relationship Type (extensible)
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address, AustralianAddress	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
preferred		0..1	boolean	Language preference indicator
generalPractitioner	S	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Patient.extension:genderIdentity.​value[x]	Base	example	Gender identity	📦4.0.1	FHIR Std.
Patient.extension:genderIdentity.​value[x]:valueCodeableConcept	Base	extensible	Gender Identity Response	⏿1.1.0	tx.ontoserver.csiro.au
Patient.extension:patientRegistrationStatus.​value[x]	Base	extensible	Medtech Patient Registration ValueSet	📦1.0.0	This IG
Patient.identifier:dva.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:dva.​type	Base	required	The DVA Entitlement for Patient	📦1.0.0	This IG
Patient.name:official.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name:preferred.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	Medtech Marital Status ValueSet	📦1.0.0	This IG
Patient.contact.relationship	Base	extensible	Contact Relationship Type	📦1.0.0	This IG
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	extensible	Common Languages in Australia	⏿2.2.1	tx.ontoserver.csiro.au
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()
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()

Summary

Mandatory: 8 elements(2 nested mandatory elements)
Must-Support: 31 elements
Prohibited: 15 elements

Structures

This structure refers to these other structures:

• AU IHI (http://hl7.org.au/fhir/StructureDefinition/au-ihi)
• AU Medicare Card Number (http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber)
• AU DVA Number (http://hl7.org.au/fhir/StructureDefinition/au-dvanumber)
• AU Health Care Card Number (http://hl7.org.au/fhir/StructureDefinition/au-healthcarecardnumber)
• AU Pensioner Concession Card Number (http://hl7.org.au/fhir/StructureDefinition/au-pensionerconcessioncardnumber)
• AU Commonwealth Seniors Health Card Number (http://hl7.org.au/fhir/StructureDefinition/au-cwlthseniorshealthcardnumber)
• AU Medical Record Number (http://hl7.org.au/fhir/StructureDefinition/au-medicalrecordnumber)
• Address (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-address)

Extensions

This structure refers to these extensions:

• https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/sex-at-birth
• https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status
• https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-location
• https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-ethnicity
• https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acholder
• https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-account-group
• https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acheldby
• https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/country-of-birth

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier
• The element 1 is sliced based on the value of Patient.name

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	AUBasePatient	A patient in an Australian healthcare context Constraints: inv-pat-0
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:indigenousStatus	S	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
extension:sexAtBirth	S	1..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:patientRegistrationStatus	S	0..1	(Complex)	Patient registration status (Medtech – required) URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status
extension		0..0
url		1..1	uri	"https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status"
value[x]		0..1	CodeableConcept	Value of extension Binding: Medtech Patient Registration ValueSet (extensible)
extension:patientLocation	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-location
extension:patientEthnicity	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-ethnicity Binding: Medtech Patient Ethnicity ValueSet (required)
extension:isAccountHolder	S	0..1	boolean	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acholder
extension:accountGroup	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-account-group Binding: Medtech Patient Account Group ValueSet (required)
extension:accountHeldBy	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acheldby
extension:countryOfBirth	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/country-of-birth Binding: Medtech Country of Birth ValueSet (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SC	0..*	AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
identifier:ihi	S	0..*	AUIHI	Identifies this patient across multiple systems
identifier:medicare	S	0..*	AUMedicareCardNumber	Identifies this patient across multiple systems
identifier:dva	S	0..*	AUDVANumber	Identifies this patient across multiple systems
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: The DVA Entitlement for Patient (required)
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/dva
value	Σ	1..1	string	DVA number Example General: 123456 Example DVA number: NBUR9080 Max Length:9
identifier:healthcare	S	0..1	AUHealthCareCardNumber	Identifies this patient across multiple systems
identifier:pen	S	0..1	AUPensionerConcessionCardNumber	Identifies this patient across multiple systems
identifier:sen	S	0..1	AUCwlthSeniorsHealthCardNumber	Identifies this patient across multiple systems
identifier:mrn	S	0..*	AUMedicalRecordNumber	Identifies this patient across multiple systems
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
Slices for name	Σ	1..2	HumanName	A name associated with the patient Slice: Unordered, Open by value:use
name:official	SΣ	1..1	HumanName	A name associated with the patient
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
name:preferred	SΣ	0..1	HumanName	A name associated with the patient
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: usual
given	SΣ	1..1	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
birthDate	SΣ	1..1	date	Date of birth extended for time and accuracy indicator
Slices for extension				Content/Rules for all slices
address	SC	0..2	AlexAddress	An address for the individual Constraints: inv-add-0, inv-add-1, inv-add-2
maritalStatus	S	0..1	CodeableConcept	Patient marital status (Medtech – required) Binding: Medtech Marital Status ValueSet (extensible)
contact	SC	0..2	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
generalPractitioner	S	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.extension:genderIdentity.​value[x]	Base	example	Gender identity	📦4.0.1	FHIR Std.
Patient.extension:genderIdentity.​value[x]:valueCodeableConcept	Base	extensible	Gender Identity Response	⏿1.1.0	tx.ontoserver.csiro.au
Patient.extension:patientRegistrationStatus.​value[x]	Base	extensible	Medtech Patient Registration ValueSet	📦1.0.0	This IG
Patient.identifier:dva.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:dva.​type	Base	required	The DVA Entitlement for Patient	📦1.0.0	This IG
Patient.name:official.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name:preferred.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	Medtech Marital Status ValueSet	📦1.0.0	This IG
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()
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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			AUBasePatient
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:birthPlace		0..0
extension:indigenousStatus	S	0..1	AustralianIndigenousStatus	Indigenous status
extension:closingTheGapRegistration		0..0
extension:mothersMaidenName		0..0
extension:interpreterRequired		0..0
extension:dateOfArrival		0..0
extension:genderIdentity		0..0
extension:sexAtBirth	S	1..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:patientRegistrationStatus	S	0..1	(Complex)	Patient registration status (Medtech – required) URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status
value[x]		0..1	CodeableConcept	Value of extension
extension:patientLocation	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-location
extension:patientEthnicity	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-ethnicity Binding: Medtech Patient Ethnicity ValueSet (required)
extension:isAccountHolder	S	0..1	boolean	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acholder
extension:accountGroup	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-account-group Binding: Medtech Patient Account Group ValueSet (required)
extension:accountHeldBy	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acheldby
extension:countryOfBirth	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/country-of-birth Binding: Medtech Country of Birth ValueSet (extensible)
Slices for identifier	SC	0..*	AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
identifier:ihi	S	0..*	AUIHI	Identifies this patient across multiple systems
identifier:medicare	S	0..*	AUMedicareCardNumber	Identifies this patient across multiple systems
identifier:dva	S	0..*	AUDVANumber	Identifies this patient across multiple systems
type		1..1	CodeableConcept	Description of identifier Binding: The DVA Entitlement for Patient (required)
identifier:healthcare	S	0..1	AUHealthCareCardNumber	Identifies this patient across multiple systems
identifier:pen	S	0..1	AUPensionerConcessionCardNumber	Identifies this patient across multiple systems
identifier:sen	S	0..1	AUCwlthSeniorsHealthCardNumber	Identifies this patient across multiple systems
identifier:mrn	S	0..*	AUMedicalRecordNumber	Identifies this patient across multiple systems
Slices for name		1..2	HumanName	A name associated with the patient Slice: Unordered, Open by value:use
name:official	S	1..1	HumanName	A name associated with the patient
use		1..1	code	usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official
family	S	1..1	string	Family name (often called 'Surname')
given	S	1..*	string	Given names (not always 'first'). Includes middle names
prefix	S	0..1	string	Parts that come before the name
name:preferred	S	0..1	HumanName	A name associated with the patient
use		1..1	code	usual | official | temp | nickname | anonymous | old | maiden Required Pattern: usual
family	S	0..0
given	S	1..1	string	Given names (not always 'first'). Includes middle names
prefix	S	0..1	string	Parts that come before the name
telecom	S	0..*	ContactPoint	A contact detail for the individual
birthDate	S	1..1	date	Date of birth extended for time and accuracy indicator
Slices for extension				Content/Rules for all slices
extension:accuracyIndicator		0..0
extension:birthTime		0..0
deceased[x]		0..0
Slices for deceased[x]				Content/Rules for all slices
deceased[x]:deceasedBoolean		0..0
deceased[x]:deceasedDateTime		0..0
address	S	0..2	AlexAddress	An address for the individual
maritalStatus	S	0..1	CodeableConcept	Patient marital status (Medtech – required) Binding: Medtech Marital Status ValueSet (extensible)
coding
system		0..1	uri	Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/marital-status
multipleBirth[x]		0..0
photo		0..0
contact	S	0..2	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
generalPractitioner	S	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
link		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier:dva.​type	Base	required	The DVA Entitlement for Patient	📦1.0.0	This IG
Patient.maritalStatus	Base	extensible	Medtech Marital Status ValueSet	📦1.0.0	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	AUBasePatient	A patient in an Australian healthcare context Constraints: inv-pat-0
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:indigenousStatus	S	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
extension:sexAtBirth	S	1..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:patientRegistrationStatus	S	0..1	(Complex)	Patient registration status (Medtech – required) URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status"
value[x]		0..1	CodeableConcept	Value of extension Binding: Medtech Patient Registration ValueSet (extensible)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/registration-status-code
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
extension:patientLocation	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-location
extension:patientEthnicity	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-ethnicity Binding: Medtech Patient Ethnicity ValueSet (required)
extension:isAccountHolder	S	0..1	boolean	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acholder
extension:accountGroup	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-account-group Binding: Medtech Patient Account Group ValueSet (required)
extension:accountHeldBy	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acheldby
extension:countryOfBirth	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/country-of-birth Binding: Medtech Country of Birth ValueSet (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SC	0..*	AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type
identifier:ihi	S	0..*	AUIHI	Identifies this patient across multiple systems
identifier:medicare	S	0..*	AUMedicareCardNumber	Identifies this patient across multiple systems
identifier:dva	S	0..*	AUDVANumber	Identifies this patient across multiple systems
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: The DVA Entitlement for Patient (required)
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/dva
value	Σ	1..1	string	DVA number Example General: 123456 Example DVA number: NBUR9080 Max Length:9
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:healthcare	S	0..1	AUHealthCareCardNumber	Identifies this patient across multiple systems
identifier:pen	S	0..1	AUPensionerConcessionCardNumber	Identifies this patient across multiple systems
identifier:sen	S	0..1	AUCwlthSeniorsHealthCardNumber	Identifies this patient across multiple systems
identifier:mrn	S	0..*	AUMedicalRecordNumber	Identifies this patient across multiple systems
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
Slices for name	Σ	1..2	HumanName	A name associated with the patient Slice: Unordered, Open by value:use
name:official	SΣ	1..1	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official
text	Σ	0..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
name:preferred	SΣ	0..1	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: usual
text	Σ	0..1	string	Text representation of the full name
given	SΣ	1..1	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	Date of birth extended for time and accuracy indicator
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
value		0..1	date	Primitive value for date
address	SC	0..2	AlexAddress	An address for the individual Constraints: inv-add-0, inv-add-1, inv-add-2
maritalStatus	S	0..1	CodeableConcept	Patient marital status (Medtech – required) Binding: Medtech Marital Status ValueSet (extensible)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/marital-status
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
contact	SC	0..2	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: Contact Relationship Type (extensible)
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address, AustralianAddress	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia (extensible)
preferred		0..1	boolean	Language preference indicator
generalPractitioner	S	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Patient.extension:genderIdentity.​value[x]	Base	example	Gender identity	📦4.0.1	FHIR Std.
Patient.extension:genderIdentity.​value[x]:valueCodeableConcept	Base	extensible	Gender Identity Response	⏿1.1.0	tx.ontoserver.csiro.au
Patient.extension:patientRegistrationStatus.​value[x]	Base	extensible	Medtech Patient Registration ValueSet	📦1.0.0	This IG
Patient.identifier:dva.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:dva.​type	Base	required	The DVA Entitlement for Patient	📦1.0.0	This IG
Patient.name:official.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name:preferred.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	Medtech Marital Status ValueSet	📦1.0.0	This IG
Patient.contact.relationship	Base	extensible	Contact Relationship Type	📦1.0.0	This IG
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	extensible	Common Languages in Australia	⏿2.2.1	tx.ontoserver.csiro.au
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()
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()