This page is part of the Australian Base IG (v4.1.2-preview: AU Base) based on FHIR R4. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• XML
• JSON
• TTL

Resource Profile: AU Base Related Person

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

Usage:

• Examples for this Resource Profile: RelatedPerson/example0, RelatedPerson/example1, RelatedPerson/example2 and RelatedPerson/example3

Formal Views of Profile Content

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

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

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	A person related to a patient in an Australian healthcare context
identifier		0..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	A human identifier for this person
relationship		0..*	CodeableConcept	The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)
address		0..*	Address, AustralianAddress	Address where the related person can be contacted or visited
communication		0..*	BackboneElement	A language which may be used to communicate with about the patient's health
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
RelatedPerson.relationship	extensible	https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
RelatedPerson.communication.language	extensible	https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	A person related to a patient in an Australian healthcare context
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	A human identifier for this person
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
relationship	Σ	0..*	CodeableConcept	The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)
address		0..*	Address, AustralianAddress	Address where the related person can be contacted or visited
communication		0..*	BackboneElement	A language which may be used to communicate with about the patient's health
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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedPerson.relationship	extensible	https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
RelatedPerson.communication.language	extensible	https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	A person related to a patient in an Australian healthcare context
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	A human identifier for this person
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
relationship	Σ	0..*	CodeableConcept	The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)
name	Σ	0..*	HumanName	A name associated with the person
telecom	Σ	0..*	ContactPoint	A contact detail for the person
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the related person was born
address		0..*	Address, AustralianAddress	Address where the related person can be contacted or visited
photo		0..*	Attachment	Image of the person
period		0..1	Period	Period of time that this relationship is considered valid
communication		0..*	BackboneElement	A language which may be used to communicate with about the patient's 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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.relationship	extensible	https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
RelatedPerson.gender	required	AdministrativeGender
RelatedPerson.communication.language	extensible	https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

This structure is derived from RelatedPerson

Summary

Maturity: 2

Differential View

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	A person related to a patient in an Australian healthcare context
identifier		0..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	A human identifier for this person
relationship		0..*	CodeableConcept	The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)
address		0..*	Address, AustralianAddress	Address where the related person can be contacted or visited
communication		0..*	BackboneElement	A language which may be used to communicate with about the patient's health
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
RelatedPerson.relationship	extensible	https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
RelatedPerson.communication.language	extensible	https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	A person related to a patient in an Australian healthcare context
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	A human identifier for this person
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
relationship	Σ	0..*	CodeableConcept	The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)
address		0..*	Address, AustralianAddress	Address where the related person can be contacted or visited
communication		0..*	BackboneElement	A language which may be used to communicate with about the patient's health
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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedPerson.relationship	extensible	https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
RelatedPerson.communication.language	extensible	https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	A person related to a patient in an Australian healthcare context
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	A human identifier for this person
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
relationship	Σ	0..*	CodeableConcept	The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)
name	Σ	0..*	HumanName	A name associated with the person
telecom	Σ	0..*	ContactPoint	A contact detail for the person
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the related person was born
address		0..*	Address, AustralianAddress	Address where the related person can be contacted or visited
photo		0..*	Attachment	Image of the person
period		0..1	Period	Period of time that this relationship is considered valid
communication		0..*	BackboneElement	A language which may be used to communicate with about the patient's 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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.relationship	extensible	https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
RelatedPerson.gender	required	AdministrativeGender
RelatedPerson.communication.language	extensible	https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

This structure is derived from RelatedPerson

Summary

Maturity: 2

Other representations of profile: CSV, Excel, Schematron