See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.

Usage Scenarios

The following are supported usage scenarios for this profile:

• Query about a person related to a patient
• Record or update information about a related person referenced by another resource

Profile Specific Implementation Guidance

• When constructing an address
  • an international address can be represented using the core Address data type
  • an Australian address SHOULD be represented using the Australian Address data type profile
• Related person names can be provided as a text representation in name.text and/or parts such as name.family and name.given.
  • name.text specifies the entire name as it is intended to be displayed. This may be provided instead of, or as well as, the specific parts. It is important to note that the presence of parts of a name, e.g. name.family and name.given, do not imply that name.text is known or needs to be supplied.
  • In this profile, the following sub-elements of name are marked as Must Support: name.use, name.text, name.family, and name.given
    • responders are required to support at least one of the following sub-elements: name.text, name.family, and name.given
    • requesters are required to support all sub-elements marked Must Support: name.use, name.text, name.family, and name.given
• See the section on Representing Communication Preferences for guidance on how to represent languages that can be used to communicate with the related person about a patient's health including preferred language and if an interpreter is required.

Changes since version 2.0.0:

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson	C	0..*	AUBaseRelatedPerson	A person related to a patient in an Australian healthcare context Constraints: inv-relper-0, inv-relper-1, inv-relper-2, inv-relper-3, inv-relper-4, inv-relper-5, au-core-relper-01, au-core-relper-02
RelatedPerson.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
RelatedPerson.Slices for extension				Content/Rules for all slices
RelatedPerson.Slices for extension.extension: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
RelatedPerson.Slices for extension.extension: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
RelatedPerson.Slices for extension.extension: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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
RelatedPerson.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
RelatedPerson.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this related person's record is in active use
RelatedPerson.patient	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(AU Core Patient)	The patient this person is related to Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.relationship	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..*	CodeableConcept	The nature of the relationship Binding: Related Person Relationship Type (extensible) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..*	HumanName	A name associated with the person Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.use	?! This element is a modifier element. SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.text	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.family	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.given	SO This element has obligations and must be supported. Σ This element is included in summaries.	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
RelatedPerson.telecom	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the person Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.address	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	Address , AustralianAddress	Address where the related person can be contacted or visited Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.relationship	Base	extensible	Related Person Relationship Type	⏿1.2.2	tx.hl7.org.au
RelatedPerson.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
au-core-relper-01	error	RelatedPerson	Either a name or a relationship shall be provided (or both)	name.exists() or relationship.exists()
au-core-relper-02	error	RelatedPerson	Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present	name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists())
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()
inv-relper-0	warning	RelatedPerson	Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-relper-1	warning	RelatedPerson	Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-relper-2	warning	RelatedPerson	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-relper-3	warning	RelatedPerson	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-relper-4	warning	RelatedPerson	Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-relper-5	warning	RelatedPerson	Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

This structure is derived from AUBaseRelatedPerson

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson	C	0..*	AUBaseRelatedPerson	A person related to a patient in an Australian healthcare context Constraints: au-core-relper-01, au-core-relper-02
RelatedPerson.patient	SO This element has obligations and must be supported.	1..1	Reference(AU Core Patient)	The patient this person is related to Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.relationship	SO This element has obligations and must be supported. C	0..*	CodeableConcept	The nature of the relationship Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name	SO This element has obligations and must be supported. C	0..*	HumanName	A name associated with the person Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.use	SO This element has obligations and must be supported.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.text	SO This element has obligations and must be supported.	0..1	string	Text representation of the full name Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.family	SO This element has obligations and must be supported.	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.given	SO This element has obligations and must be supported.	0..*	string	Given names (not always 'first'). Includes middle names Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.telecom	SO This element has obligations and must be supported.	0..*	ContactPoint	A contact detail for the person Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.address	SO This element has obligations and must be supported.	0..*	Address, AustralianAddress	Address where the related person can be contacted or visited Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
au-core-relper-01	error	RelatedPerson	Either a name or a relationship shall be provided (or both)	name.exists() or relationship.exists()
au-core-relper-02	error	RelatedPerson	Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present	name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists())

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson	C	0..*	AUBaseRelatedPerson	A person related to a patient in an Australian healthcare context Constraints: inv-relper-0, inv-relper-1, inv-relper-2, inv-relper-3, inv-relper-4, inv-relper-5, au-core-relper-01, au-core-relper-02
RelatedPerson.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
RelatedPerson.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
RelatedPerson.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
RelatedPerson.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
RelatedPerson.contained		0..*	Resource	Contained, inline Resources
RelatedPerson.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
RelatedPerson.Slices for extension.extension: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
RelatedPerson.Slices for extension.extension: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
RelatedPerson.Slices for extension.extension: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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
RelatedPerson.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
RelatedPerson.identifier	Σ This element is included in summaries.	0..*	Identifier , AUIHI , AUMedicareCardNumber , AUDVANumber , AUHealthCareCardNumber , AUPensionerConcessionCardNumber , AUCwlthSeniorsHealthCardNumber , AUMedicalRecordNumber , AUInsuranceMemberNumber	A human identifier for this person
RelatedPerson.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this related person's record is in active use
RelatedPerson.patient	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(AU Core Patient)	The patient this person is related to Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.relationship	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..*	CodeableConcept	The nature of the relationship Binding: Related Person Relationship Type (extensible) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..*	HumanName	A name associated with the person Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
RelatedPerson.name.use	?! This element is a modifier element. SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.text	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.family	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.given	SO This element has obligations and must be supported. Σ This element is included in summaries.	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
RelatedPerson.name.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
RelatedPerson.name.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
RelatedPerson.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
RelatedPerson.telecom	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the person Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
RelatedPerson.birthDate	Σ This element is included in summaries.	0..1	date	The date on which the related person was born
RelatedPerson.address	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	Address , AustralianAddress	Address where the related person can be contacted or visited Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.photo		0..*	Attachment	Image of the person
RelatedPerson.period		0..1	Period	Period of time that this relationship is considered valid
RelatedPerson.communication		0..*	BackboneElement	A language which may be used to communicate with about the patient's health
RelatedPerson.communication.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.communication.extension		0..*	Extension	Additional content defined by implementations
RelatedPerson.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
RelatedPerson.communication.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)
RelatedPerson.communication.preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
RelatedPerson.relationship	Base	extensible	Related Person Relationship Type	⏿1.2.2	tx.hl7.org.au
RelatedPerson.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
RelatedPerson.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
RelatedPerson.communication.​language	Base	extensible	Common Languages in Australia	⏿2.2.1	tx.hl7.org.au

Constraints

Id	Grade	Path(s)	Description	Expression
au-core-relper-01	error	RelatedPerson	Either a name or a relationship shall be provided (or both)	name.exists() or relationship.exists()
au-core-relper-02	error	RelatedPerson	Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present	name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists())
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()
inv-relper-0	warning	RelatedPerson	Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-relper-1	warning	RelatedPerson	Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-relper-2	warning	RelatedPerson	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-relper-3	warning	RelatedPerson	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-relper-4	warning	RelatedPerson	Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-relper-5	warning	RelatedPerson	Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson	C	0..*	AUBaseRelatedPerson	A person related to a patient in an Australian healthcare context Constraints: inv-relper-0, inv-relper-1, inv-relper-2, inv-relper-3, inv-relper-4, inv-relper-5, au-core-relper-01, au-core-relper-02
RelatedPerson.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
RelatedPerson.Slices for extension				Content/Rules for all slices
RelatedPerson.Slices for extension.extension: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
RelatedPerson.Slices for extension.extension: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
RelatedPerson.Slices for extension.extension: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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
RelatedPerson.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
RelatedPerson.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this related person's record is in active use
RelatedPerson.patient	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(AU Core Patient)	The patient this person is related to Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.relationship	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..*	CodeableConcept	The nature of the relationship Binding: Related Person Relationship Type (extensible) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..*	HumanName	A name associated with the person Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.use	?! This element is a modifier element. SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.text	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.family	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.given	SO This element has obligations and must be supported. Σ This element is included in summaries.	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
RelatedPerson.telecom	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the person Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.address	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	Address , AustralianAddress	Address where the related person can be contacted or visited Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.relationship	Base	extensible	Related Person Relationship Type	⏿1.2.2	tx.hl7.org.au
RelatedPerson.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
au-core-relper-01	error	RelatedPerson	Either a name or a relationship shall be provided (or both)	name.exists() or relationship.exists()
au-core-relper-02	error	RelatedPerson	Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present	name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists())
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()
inv-relper-0	warning	RelatedPerson	Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-relper-1	warning	RelatedPerson	Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-relper-2	warning	RelatedPerson	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-relper-3	warning	RelatedPerson	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-relper-4	warning	RelatedPerson	Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-relper-5	warning	RelatedPerson	Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

Differential View

This structure is derived from AUBaseRelatedPerson

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson	C	0..*	AUBaseRelatedPerson	A person related to a patient in an Australian healthcare context Constraints: au-core-relper-01, au-core-relper-02
RelatedPerson.patient	SO This element has obligations and must be supported.	1..1	Reference(AU Core Patient)	The patient this person is related to Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.relationship	SO This element has obligations and must be supported. C	0..*	CodeableConcept	The nature of the relationship Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name	SO This element has obligations and must be supported. C	0..*	HumanName	A name associated with the person Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.use	SO This element has obligations and must be supported.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.text	SO This element has obligations and must be supported.	0..1	string	Text representation of the full name Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.family	SO This element has obligations and must be supported.	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.given	SO This element has obligations and must be supported.	0..*	string	Given names (not always 'first'). Includes middle names Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.telecom	SO This element has obligations and must be supported.	0..*	ContactPoint	A contact detail for the person Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.address	SO This element has obligations and must be supported.	0..*	Address, AustralianAddress	Address where the related person can be contacted or visited Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
au-core-relper-01	error	RelatedPerson	Either a name or a relationship shall be provided (or both)	name.exists() or relationship.exists()
au-core-relper-02	error	RelatedPerson	Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present	name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson	C	0..*	AUBaseRelatedPerson	A person related to a patient in an Australian healthcare context Constraints: inv-relper-0, inv-relper-1, inv-relper-2, inv-relper-3, inv-relper-4, inv-relper-5, au-core-relper-01, au-core-relper-02
RelatedPerson.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
RelatedPerson.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
RelatedPerson.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
RelatedPerson.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
RelatedPerson.contained		0..*	Resource	Contained, inline Resources
RelatedPerson.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
RelatedPerson.Slices for extension.extension: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
RelatedPerson.Slices for extension.extension: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
RelatedPerson.Slices for extension.extension: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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
RelatedPerson.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
RelatedPerson.identifier	Σ This element is included in summaries.	0..*	Identifier , AUIHI , AUMedicareCardNumber , AUDVANumber , AUHealthCareCardNumber , AUPensionerConcessionCardNumber , AUCwlthSeniorsHealthCardNumber , AUMedicalRecordNumber , AUInsuranceMemberNumber	A human identifier for this person
RelatedPerson.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this related person's record is in active use
RelatedPerson.patient	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(AU Core Patient)	The patient this person is related to Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.relationship	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..*	CodeableConcept	The nature of the relationship Binding: Related Person Relationship Type (extensible) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..*	HumanName	A name associated with the person Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
RelatedPerson.name.use	?! This element is a modifier element. SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.text	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.family	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname') Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.name.given	SO This element has obligations and must be supported. Σ This element is included in summaries.	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
RelatedPerson.name.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
RelatedPerson.name.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
RelatedPerson.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
RelatedPerson.telecom	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the person Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
RelatedPerson.birthDate	Σ This element is included in summaries.	0..1	date	The date on which the related person was born
RelatedPerson.address	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	Address , AustralianAddress	Address where the related person can be contacted or visited Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
RelatedPerson.photo		0..*	Attachment	Image of the person
RelatedPerson.period		0..1	Period	Period of time that this relationship is considered valid
RelatedPerson.communication		0..*	BackboneElement	A language which may be used to communicate with about the patient's health
RelatedPerson.communication.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.communication.extension		0..*	Extension	Additional content defined by implementations
RelatedPerson.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
RelatedPerson.communication.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)
RelatedPerson.communication.preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
RelatedPerson.relationship	Base	extensible	Related Person Relationship Type	⏿1.2.2	tx.hl7.org.au
RelatedPerson.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
RelatedPerson.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
RelatedPerson.communication.​language	Base	extensible	Common Languages in Australia	⏿2.2.1	tx.hl7.org.au

Constraints

Id	Grade	Path(s)	Description	Expression
au-core-relper-01	error	RelatedPerson	Either a name or a relationship shall be provided (or both)	name.exists() or relationship.exists()
au-core-relper-02	error	RelatedPerson	Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present	name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists())
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()
inv-relper-0	warning	RelatedPerson	Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-relper-1	warning	RelatedPerson	Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-relper-2	warning	RelatedPerson	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-relper-3	warning	RelatedPerson	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	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-relper-4	warning	RelatedPerson	Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-relper-5	warning	RelatedPerson	Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

This structure is derived from AUBaseRelatedPerson

Summary

Must-Support: 9 elements

Structures

This structure refers to these other structures:

• AU Core Patient (http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient)

Maturity: 2

Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.

FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.

Any search parameter defined in FHIR may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Mandatory Search Parameters

The following search parameters and search parameter combinations SHALL be supported:

1. SHALL support searching using the patient search parameter:
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

   GET [base]/RelatedPerson?patient={type/}[id] or optionally GET [base]/RelatedPerson?patient.identifier=[system|][code]

   Example:

   1. GET [base]/RelatedPerson?patient=5678
   2. GET [base]/RelatedPerson?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
   3. GET [base]/RelatedPerson?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

   Implementation Notes: Fetches a bundle of all RelatedPerson resources for the specified patient (how to search by reference and how to search by token)

Optional Search Parameters

The following search parameters and search parameter combinations SHOULD be supported:

1. SHOULD support searching using the _id search parameter:

   GET [base]/RelatedPerson?_id=[id]

   Example:

   1. GET [base]/RelatedPerson?_id=5678

   Implementation Notes: Fetches a bundle with the requested RelatedPerson, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)

2. SHOULD support searching using the combination of the patient and relationship search parameters:
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

   GET [base]/RelatedPerson?patient={type/}[id]&relationship={system|}[code]

   Example:

   1. GET [base]/RelatedPerson?patient=5678&relationship=http://terminology.hl7.org/CodeSystem/v3-RoleCode|MTH
   2. GET [base]/RelatedPerson?patient.identifier=http://example.org/fhir/mrn|12345&relationship=http://terminology.hl7.org/CodeSystem/v3-RoleCode|MTH

   Implementation Notes: Fetches a bundle of all RelatedPerson resources for the specified patient and relationship (how to search by reference and how to search by token)

3. SHOULD support searching using the combination of the patient and name search parameters:
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

   GET [base]/RelatedPerson?patient={type/}[id]&name=[string]

   Example:

   1. GET [base]/RelatedPerson?patient=5678&name=Wang
   2. GET [base]/RelatedPerson?patient.identifier=http://example.org/fhir/mrn|12345&name=Wang

   Implementation Notes: Fetches a bundle of all RelatedPerson resources for the specified patient and name (how to search by reference and how to search by string)