Medtech ALEX® Implementation Guide - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• JSON

Resource Profile: Patient IPS Profile

The Patient resource for IPS

Usage:

• Use this Resource Profile: Bundle - IPS (AU)

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	AlexPatient	A patient in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
indigenousStatus	S	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
sexAtBirth	S	1..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
patientRegistrationStatus	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status Binding: Medtech Patient Registration ValueSet (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
patientLocation	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-location ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
patientEthnicity	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-ethnicity Binding: Medtech Patient Ethnicity ValueSet (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
isAccountHolder	S	0..1	boolean	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acholder ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
accountGroup	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-account-group Binding: Medtech Patient Account Group ValueSet (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
accountHeldBy	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acheldby ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	SC	0..*	AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children
identifier:ihi	S	0..*	AUIHI	Identifies this patient across multiple systems ele-1: All FHIR elements must have a @value or children
identifier:medicare	S	0..*	AUMedicareCardNumber	Identifies this patient across multiple systems ele-1: All FHIR elements must have a @value or children
identifier:dva	S	0..*	AUDVANumber	Identifies this patient across multiple systems ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Description of identifier Binding: The DVA Entitlement for Patient (required) ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://ns.electronichealth.net.au/id/dva
value	Σ	1..1	string	DVA number ele-1: All FHIR elements must have a @value or children Example General: 123456 Example DVA number: NBUR9080 Max Length:9
identifier:healthcare	S	0..1	AUHealthCareCardNumber	Identifies this patient across multiple systems ele-1: All FHIR elements must have a @value or children
identifier:pen	S	0..1	AUPensionerConcessionCardNumber	Identifies this patient across multiple systems ele-1: All FHIR elements must have a @value or children
identifier:sen	S	0..1	AUCwlthSeniorsHealthCardNumber	Identifies this patient across multiple systems ele-1: All FHIR elements must have a @value or children
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
Slices for name	Σ	1..2	HumanName	A name associated with the patient Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children
name:official	SΣ	1..1	HumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Required Pattern: official
family	SΣ	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣ	1..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
name:preferred	SΣ	0..1	HumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Required Pattern: usual
given	SΣ	1..1	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	1..1	date	Date of birth extended for time and accuracy indicator ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
address	SC	0..2	AlexAddress	An address for the individual ele-1: All FHIR elements must have a @value or children inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
contact	SC	0..2	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient ele-1: All FHIR elements must have a @value or children pat-1: SHALL at least contain a contact's details or a reference to an organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
generalPractitioner	S	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.extension:genderIdentity.value[x]	example	GenderIdentity http://hl7.org/fhir/ValueSet/gender-identity from the FHIR Standard
Patient.extension:genderIdentity.value[x]:valueCodeableConcept	extensible	GenderIdentityResponse https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 from https://tx.ontoserver.csiro.au/fhir
Patient.identifier:dva.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:dva.type	required	PatientDvaEntitlementVs https://alexapi.medtechglobal.com.au/fhir/ValueSet/patient-dva-entitlement from this IG
Patient.name:official.use	required	Pattern: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:preferred.use	required	Pattern: usual http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

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

This structure is derived from AlexPatient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	AlexPatient	A patient in an Australian healthcare context
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	AlexPatient	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
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
indigenousStatus	S	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
sexAtBirth	S	1..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
patientRegistrationStatus	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status Binding: Medtech Patient Registration ValueSet (required)
patientLocation	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-location
patientEthnicity	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-ethnicity Binding: Medtech Patient Ethnicity ValueSet (required)
isAccountHolder	S	0..1	boolean	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acholder
accountGroup	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-account-group Binding: Medtech Patient Account Group ValueSet (required)
accountHeldBy	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acheldby
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SC	0..*	AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber	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
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	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
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	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	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 inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
contact	SC	0..2	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
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	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.extension:genderIdentity.value[x]	example	GenderIdentity http://hl7.org/fhir/ValueSet/gender-identity from the FHIR Standard
Patient.extension:genderIdentity.value[x]:valueCodeableConcept	extensible	GenderIdentityResponse https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 from https://tx.ontoserver.csiro.au/fhir
Patient.identifier:dva.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:dva.type	required	PatientDvaEntitlementVs https://alexapi.medtechglobal.com.au/fhir/ValueSet/patient-dva-entitlement from this IG
Patient.name:official.use	required	Pattern: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:preferred.use	required	Pattern: usual http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.contact.relationship	extensible	ContactRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 from this IG
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 from https://tx.ontoserver.csiro.au/fhir
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

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

This structure is derived from AlexPatient

Summary

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	AlexPatient	A patient in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
indigenousStatus	S	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
sexAtBirth	S	1..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
patientRegistrationStatus	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status Binding: Medtech Patient Registration ValueSet (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
patientLocation	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-location ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
patientEthnicity	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-ethnicity Binding: Medtech Patient Ethnicity ValueSet (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
isAccountHolder	S	0..1	boolean	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acholder ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
accountGroup	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-account-group Binding: Medtech Patient Account Group ValueSet (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
accountHeldBy	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acheldby ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	SC	0..*	AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children
identifier:ihi	S	0..*	AUIHI	Identifies this patient across multiple systems ele-1: All FHIR elements must have a @value or children
identifier:medicare	S	0..*	AUMedicareCardNumber	Identifies this patient across multiple systems ele-1: All FHIR elements must have a @value or children
identifier:dva	S	0..*	AUDVANumber	Identifies this patient across multiple systems ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Description of identifier Binding: The DVA Entitlement for Patient (required) ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://ns.electronichealth.net.au/id/dva
value	Σ	1..1	string	DVA number ele-1: All FHIR elements must have a @value or children Example General: 123456 Example DVA number: NBUR9080 Max Length:9
identifier:healthcare	S	0..1	AUHealthCareCardNumber	Identifies this patient across multiple systems ele-1: All FHIR elements must have a @value or children
identifier:pen	S	0..1	AUPensionerConcessionCardNumber	Identifies this patient across multiple systems ele-1: All FHIR elements must have a @value or children
identifier:sen	S	0..1	AUCwlthSeniorsHealthCardNumber	Identifies this patient across multiple systems ele-1: All FHIR elements must have a @value or children
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
Slices for name	Σ	1..2	HumanName	A name associated with the patient Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children
name:official	SΣ	1..1	HumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Required Pattern: official
family	SΣ	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣ	1..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
name:preferred	SΣ	0..1	HumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Required Pattern: usual
given	SΣ	1..1	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	1..1	date	Date of birth extended for time and accuracy indicator ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
address	SC	0..2	AlexAddress	An address for the individual ele-1: All FHIR elements must have a @value or children inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
contact	SC	0..2	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient ele-1: All FHIR elements must have a @value or children pat-1: SHALL at least contain a contact's details or a reference to an organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
generalPractitioner	S	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.extension:genderIdentity.value[x]	example	GenderIdentity http://hl7.org/fhir/ValueSet/gender-identity from the FHIR Standard
Patient.extension:genderIdentity.value[x]:valueCodeableConcept	extensible	GenderIdentityResponse https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 from https://tx.ontoserver.csiro.au/fhir
Patient.identifier:dva.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:dva.type	required	PatientDvaEntitlementVs https://alexapi.medtechglobal.com.au/fhir/ValueSet/patient-dva-entitlement from this IG
Patient.name:official.use	required	Pattern: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:preferred.use	required	Pattern: usual http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

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

Differential View

This structure is derived from AlexPatient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	AlexPatient	A patient in an Australian healthcare context
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	AlexPatient	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
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
indigenousStatus	S	0..1	Coding	Indigenous status URL: http://hl7.org.au/fhir/StructureDefinition/indigenous-status Binding: Australian Indigenous Status (required)
sexAtBirth	S	1..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
patientRegistrationStatus	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status Binding: Medtech Patient Registration ValueSet (required)
patientLocation	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-location
patientEthnicity	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-ethnicity Binding: Medtech Patient Ethnicity ValueSet (required)
isAccountHolder	S	0..1	boolean	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acholder
accountGroup	S	0..1	CodeableConcept	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-account-group Binding: Medtech Patient Account Group ValueSet (required)
accountHeldBy	S	0..1	Reference()	Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acheldby
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SC	0..*	AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber	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
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	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
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	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	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 inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
contact	SC	0..2	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
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	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.extension:genderIdentity.value[x]	example	GenderIdentity http://hl7.org/fhir/ValueSet/gender-identity from the FHIR Standard
Patient.extension:genderIdentity.value[x]:valueCodeableConcept	extensible	GenderIdentityResponse https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1 from https://tx.ontoserver.csiro.au/fhir
Patient.identifier:dva.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:dva.type	required	PatientDvaEntitlementVs https://alexapi.medtechglobal.com.au/fhir/ValueSet/patient-dva-entitlement from this IG
Patient.name:official.use	required	Pattern: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:preferred.use	required	Pattern: usual http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.contact.relationship	extensible	ContactRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/contact-relationship-type-3 from this IG
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 from https://tx.ontoserver.csiro.au/fhir
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

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

This structure is derived from AlexPatient

Summary

Other representations of profile: CSV, Excel, Schematron