Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

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

Resource Profile: ADHA Authoring RelatedPerson

The purpose of this profile is to define a representation of a related person in the role of an author or observer for exchange usage scenarios to support the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

Usage:

• Refer to this Resource Profile: ADHA Advance Care Directive Custodian Record Composition, ADHA Advance Care Planning Composition, ADHA Core Composition, ADHA Document Composition... Show 17 more, ADHA Personal Health Notes Composition, ADHA Personal Health Summary Composition, ADHA Personal Health Summary Composition, ADHA Personal Observations Composition, ADHA Core Condition, ADHA Advance Care Planning Document DocumentReference, ADHA Core DocumentReference, ADHA Core MedicationAdministration, ADHA Core MedicationDispense, ADHA Core MedicationRequest, ADHA Core Observation, ADHA Diagnostic Result Observation, ADHA Imaging Result Observation, ADHA Pathology Result Observation, ADHA Simple Observation, ADHA Core Procedure and ADHA Core ServiceRequest
• Examples for this Resource Profile: RelatedPerson/mhr-field-sally, RelatedPerson/mhr-smith-bob-oliver, RelatedPerson/mhr-smith-bob-trevor, RelatedPerson/mhr-smith-rosalia-baby... Show 2 more, RelatedPerson/mhr-smith-rosalia-oliver and RelatedPerson/mhr-smith-rosalia-trevor

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 ADHARelatedPersonCore

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	ADHARelatedPersonCore	A person related to a patient in an Australian healthcare context inv-dh-relper-03: At least one related person name shall have a family name
identifier		1..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	A human identifier for this person
name		1..*	HumanName	A name associated with the person
telecom		1..*	ContactPoint	A contact detail for the person
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-relper-03	error	RelatedPerson	At least one related person name shall have a family name : name.family.exists()

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	ADHARelatedPersonCore	A person related to a patient in an Australian healthcare context inv-relper-0: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-relper-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-relper-2: 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-relper-3: 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-relper-4: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply inv-dh-relper-01: If present, name shall at least have text, family name, or given name inv-dh-relper-03: At least one related person name shall have a family name
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
genderIdentity	C	0..*	(Complex)	Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
individualPronouns	C	0..*	(Complex)	Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
recordedSexOrGender	C	0..*	(Complex)	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. 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. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	A human identifier for this person Slice: Unordered, Open by pattern:type
identifier:ihi	SC	0..1	AUIHI	Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
identifier:medicare	S	0..1	AUMedicareCardNumber	Medicare Card Number
identifier:dva	S	0..1	AUDVANumber	Department of Veterans' Affairs (DVA) Number
active	?!Σ	0..1	boolean	Whether this related person's record is in active use Fixed Value: true
patient	SΣC	1..1	Reference(ADHA Core Patient)	The patient this person is related to inv-dh-relper-02: At least a reference, identifier or display shall be present
relationship	SΣ	1..*	CodeableConcept	The nature of the relationship Binding: Related Person Relationship Type (extensible)
name	SΣC	1..*	HumanName	A name associated with the person
telecom	SΣ	1..*	ContactPoint	A contact detail for the person
address	S	0..*	Address, AustralianAddress	Address where the related person can be contacted or visited
communication	S	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	S	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	S	0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.relationship	extensible	RelatedPersonRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 from https://tx.ontoserver.csiro.au/fhir
RelatedPerson.communication.language	extensible	CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-relper-03	error	RelatedPerson	At least one related person name shall have a family name : name.family.exists()

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	ADHARelatedPersonCore	A person related to a patient in an Australian healthcare context inv-relper-0: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-relper-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-relper-2: 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-relper-3: 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-relper-4: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply inv-dh-relper-01: If present, name shall at least have text, family name, or given name inv-dh-relper-03: At least one related person name shall have a family name
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		0..*	Extension	Extension Slice: Unordered, Open by value:url
genderIdentity	C	0..*	(Complex)	Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
individualPronouns	C	0..*	(Complex)	Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
recordedSexOrGender	C	0..*	(Complex)	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. 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. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	A human identifier for this person Slice: Unordered, Open by pattern:type
identifier:ihi	SC	0..1	AUIHI	Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
identifier:medicare	S	0..1	AUMedicareCardNumber	Medicare Card Number
identifier:dva	S	0..1	AUDVANumber	Department of Veterans' Affairs (DVA) Number
active	?!Σ	0..1	boolean	Whether this related person's record is in active use Fixed Value: true
patient	SΣC	1..1	Reference(ADHA Core Patient)	The patient this person is related to inv-dh-relper-02: At least a reference, identifier or display shall be present
relationship	SΣ	1..*	CodeableConcept	The nature of the relationship Binding: Related Person Relationship Type (extensible)
name	SΣC	1..*	HumanName	A name associated with the person
telecom	SΣ	1..*	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	S	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	S	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	S	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	S	0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
RelatedPerson.relationship	extensible	RelatedPersonRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 from https://tx.ontoserver.csiro.au/fhir
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
RelatedPerson.communication.language	extensible	CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-relper-03	error	RelatedPerson	At least one related person name shall have a family name : name.family.exists()

This structure is derived from ADHARelatedPersonCore

Summary

Mandatory: 3 elements

Differential View

This structure is derived from ADHARelatedPersonCore

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	ADHARelatedPersonCore	A person related to a patient in an Australian healthcare context inv-dh-relper-03: At least one related person name shall have a family name
identifier		1..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	A human identifier for this person
name		1..*	HumanName	A name associated with the person
telecom		1..*	ContactPoint	A contact detail for the person
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-relper-03	error	RelatedPerson	At least one related person name shall have a family name : name.family.exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	ADHARelatedPersonCore	A person related to a patient in an Australian healthcare context inv-relper-0: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-relper-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-relper-2: 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-relper-3: 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-relper-4: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply inv-dh-relper-01: If present, name shall at least have text, family name, or given name inv-dh-relper-03: At least one related person name shall have a family name
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
genderIdentity	C	0..*	(Complex)	Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
individualPronouns	C	0..*	(Complex)	Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
recordedSexOrGender	C	0..*	(Complex)	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. 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. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	A human identifier for this person Slice: Unordered, Open by pattern:type
identifier:ihi	SC	0..1	AUIHI	Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
identifier:medicare	S	0..1	AUMedicareCardNumber	Medicare Card Number
identifier:dva	S	0..1	AUDVANumber	Department of Veterans' Affairs (DVA) Number
active	?!Σ	0..1	boolean	Whether this related person's record is in active use Fixed Value: true
patient	SΣC	1..1	Reference(ADHA Core Patient)	The patient this person is related to inv-dh-relper-02: At least a reference, identifier or display shall be present
relationship	SΣ	1..*	CodeableConcept	The nature of the relationship Binding: Related Person Relationship Type (extensible)
name	SΣC	1..*	HumanName	A name associated with the person
telecom	SΣ	1..*	ContactPoint	A contact detail for the person
address	S	0..*	Address, AustralianAddress	Address where the related person can be contacted or visited
communication	S	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	S	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	S	0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.relationship	extensible	RelatedPersonRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 from https://tx.ontoserver.csiro.au/fhir
RelatedPerson.communication.language	extensible	CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-relper-03	error	RelatedPerson	At least one related person name shall have a family name : name.family.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	ADHARelatedPersonCore	A person related to a patient in an Australian healthcare context inv-relper-0: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-relper-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-relper-2: 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-relper-3: 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-relper-4: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply inv-dh-relper-01: If present, name shall at least have text, family name, or given name inv-dh-relper-03: At least one related person name shall have a family name
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		0..*	Extension	Extension Slice: Unordered, Open by value:url
genderIdentity	C	0..*	(Complex)	Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
individualPronouns	C	0..*	(Complex)	Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
recordedSexOrGender	C	0..*	(Complex)	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. 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. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber	A human identifier for this person Slice: Unordered, Open by pattern:type
identifier:ihi	SC	0..1	AUIHI	Individual Healthcare Identifier (IHI) inv-ihi-value-0: IHI shall be an exactly 16 digit number inv-ihi-value-1: IHI prefix is 800360 inv-ihi-value-2: IHI shall pass the Luhn algorithm check
identifier:medicare	S	0..1	AUMedicareCardNumber	Medicare Card Number
identifier:dva	S	0..1	AUDVANumber	Department of Veterans' Affairs (DVA) Number
active	?!Σ	0..1	boolean	Whether this related person's record is in active use Fixed Value: true
patient	SΣC	1..1	Reference(ADHA Core Patient)	The patient this person is related to inv-dh-relper-02: At least a reference, identifier or display shall be present
relationship	SΣ	1..*	CodeableConcept	The nature of the relationship Binding: Related Person Relationship Type (extensible)
name	SΣC	1..*	HumanName	A name associated with the person
telecom	SΣ	1..*	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	S	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	S	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	S	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	S	0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
RelatedPerson.relationship	extensible	RelatedPersonRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 from https://tx.ontoserver.csiro.au/fhir
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
RelatedPerson.communication.language	extensible	CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-relper-03	error	RelatedPerson	At least one related person name shall have a family name : name.family.exists()

This structure is derived from ADHARelatedPersonCore

Summary

Mandatory: 3 elements

Other representations of profile: CSV, Excel, Schematron

Notes: