Profile Comparison between http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient vs http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient

Messages

Metadata

Name	Value		Comments
abstract	false
baseDefinition	http://hl7.org.au/fhir/StructureDefinition/au-patient
copyright	Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.
description	This profile sets minimum expectations for a Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It is based on the [AU Base Patient](http://build.fhir.org/ig/hl7au/au-fhir-base/StructureDefinition-au-patient.html) profile and identifies the *additional* mandatory core elements, extensions, vocabularies and value sets that **SHALL** be present in the Patient when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
experimental
fhirVersion	4.0.1
jurisdiction
jurisdiction[0]	urn:iso:std:iso:3166#AU
kind	resource
name	AUCorePatient
publisher	HL7 Australia
purpose
status	active
title	AU Core Patient
type	Patient
url	http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient

Structure

Name	L Flags	L Card.	L Type	L Description & Constraints	R Flags	R Card.	R Type	R Description & Constraints	Comments
Patient	C	0..*	AUBasePatient	A patient in the context of electronic exchange of health information inv-pat-0: If present, birth time's date shall be the birth date inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pat-3: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply inv-pat-4: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply au-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present au-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present	C	0..*	AUBasePatient	A patient in the context of electronic exchange of health information inv-pat-0: If present, birth time's date shall be the birth date inv-pat-1: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pat-2: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pat-3: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply inv-pat-4: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply inv-pat-5: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply au-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present au-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
id	Σ	0..1	id	Logical id of this artifact	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: ?? (preferred): A human language. Additional Bindings Purpose ?? Max Binding		0..1	code	Language of the resource content Binding: ?? (preferred): A human language. Additional Bindings Purpose ?? Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url		0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOC	1..*	??, ??, ??, ??, ??, ??, ??, ??, ??	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester	SOC	1..*	??, ??, ??, ??, ??, ??, ??, ??, ??	Identifies this patient across multiple systems Slice: Unordered, Open by pattern:type Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester	Type Mismatch: Identifier([CanonicalType[http://hl7.org/fhir/StructureDefinition/Identifier], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-ihi], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-dvanumber], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-healthcarecardnumber], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-pensionerconcessioncardnumber], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-cwlthseniorshealthcardnumber], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-medicalrecordnumber], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-insurancemembernumber]]) vs Identifier([CanonicalType[http://hl7.org/fhir/StructureDefinition/Identifier], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-ihi], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-dvanumber], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-healthcarecardnumber], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-pensionerconcessioncardnumber], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-cwlthseniorshealthcardnumber], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-medicalrecordnumber], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-insurancemembernumber]])
active	?!Σ	0..1	boolean	Whether this patient's record is in active use	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SOΣC	1..*	HumanName	A name associated with the patient au-core-pat-04: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester	SOΣC	1..*	HumanName	A name associated with the patient au-core-pat-03: At least text, family name, or given name shall be present, or if neither is available, the Data Absent Reason extension shall be present Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SOΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name. Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester	?!SOΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
text	SOΣ	0..1	string	Text representation of the full name Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester	SOΣ	0..1	string	Text representation of the full name Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
family	SOΣ	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester	SOΣ	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
given	SOΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester	SOΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name	Σ	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	Σ	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	Σ	0..1	Period	Time period when name was/is in use
telecom	SOΣ	0..*	ContactPoint	A contact detail for the individual Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester	SOΣ	0..*	ContactPoint	A contact detail for the individual Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
gender	SOΣ	1..1	code	male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester	SOΣ	1..1	code	male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
birthDate	SOΣC	1..1	date	Date of birth extended for time and accuracy indicator Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester	SOΣC	1..1	date	Date of birth extended for time and accuracy indicator Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
id		0..1	string	xml:id (or equivalent in JSON)		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url		0..*	Extension	Extension Slice: Unordered, Open by value:url
value		0..1	date	Primitive value for date		0..1	date	Primitive value for date
Slices for deceased[x]	?!Σ	0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this	?!Σ	0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
address	SOC	0..*	??, ??	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' Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester	SOC	0..*	??, ??	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' Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: ?? (extensible): The domestic partnership status of a person.		0..1	CodeableConcept	Marital (civil) status of a patient Binding: ?? (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1	boolean, integer	Whether patient is part of a multiple birth		0..1	boolean, integer	Whether patient is part of a multiple birth
photo		0..*	Attachment	Image of the patient		0..*	Attachment	Image of the patient
contact	C	0..*	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	C	0..*	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		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: ?? (extensible)		0..*	CodeableConcept	The kind of relationship Binding: ?? (extensible)
name		0..1	HumanName	A name associated with the contact person		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person		0..*	ContactPoint	A contact detail for the person
address		0..1	??, ??	Address for the contact person		0..1	??, ??	Address for the contact person	Type Mismatch: Address([CanonicalType[http://hl7.org/fhir/StructureDefinition/Address], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-address]]) vs Address([CanonicalType[http://hl7.org/fhir/StructureDefinition/Address], CanonicalType[http://hl7.org.au/fhir/StructureDefinition/au-address]])
gender		0..1	code	male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes.		0..1	code	male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact	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		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication	SO	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester	SO	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	SO	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: ?? (extensible) Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester	SO	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: ?? (extensible) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
preferred	SO	0..1	boolean	Language preference indicator Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester	SO	0..1	boolean	Language preference indicator Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider		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	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual person	?!Σ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: ?? (required): The type of link between this patient resource and another patient resource.	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: ?? (required): The type of link between this patient resource and another patient resource.
Documentation for this format