AU Base Implementation Guide
5.0.0 - Working Standard Australia flag

This page is part of the Australian Base IG (v5.0.0: R4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: AUBaseRelatedPerson - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the au-relatedperson resource profile.

Guidance on how to interpret the contents of this table can be found here

0. RelatedPerson
ShortA person related to a patient in an Australian healthcare context
Invariantsinv-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 (extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')))
inv-relper-1: 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').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')))
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 (extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')))
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 (extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')))
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 (extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')))
2. RelatedPerson.extension
SlicingThis element introduces a set of slices on RelatedPerson.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. RelatedPerson.extension:genderIdentity
    Slice NamegenderIdentity
    ShortGender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
    Comments

    The individual's gender identity is populated in the extension:value.value[x] of the Individual Gender Identity extension and shall contain one of the codes from the Gender Identity Response value set if any of the codes within the value set can apply.

    See Australian Bureau of Statics (ABS) Standard for Sex, Gender, Variations of Sex Characteristics and Sexual Orientation Variables, 2020 for further materials.

    TypeExtension(Individual Gender Identity) (Complex Extension)
    6. RelatedPerson.extension:individualPronouns
    Slice NameindividualPronouns
    ShortPronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
    Comments

    The individual's pronouns are populated in the extension:value.value[x] of the Individual Pronouns extension and shall contain one of the codes from the Australian Pronouns value set if any of the codes within the value set can apply.

    TypeExtension(Individual Pronouns) (Complex Extension)
    8. RelatedPerson.extension:recordedSexOrGender
    Slice NamerecordedSexOrGender
    ShortRecorded 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
    Comments

    The type of recorded sex or gender is populated in the extension:type.value[x] of the Person Recorded Sex or Gender extension and shall contain one of the codes from the AU Recorded Sex or Gender Type value set if any of the codes within the value set can apply.

    The document from which the sex or gender property was acquired is populated in the extension:sourceDocument.value[x] of the Person Recorded Sex or Gender extension and shall contain one of the codes from the AU Recorded Sex or Gender (RSG) Source Document Type value set if any of the codes within the value set can apply.

    The jurisdiction that issued the document where the sex or gender was acquired is populated in the extension:jurisdiction.value[x] of the Person Recorded Sex or Gender extension and shall contain one of the codes from the Jurisdiction ValueSet - AU Extended value set if any of the codes within the value set can apply.

    TypeExtension(Person Recorded Sex Or Gender) (Complex Extension)
    10. RelatedPerson.identifier
    Definition

    Identifier for a person within a particular scope.

    ShortA human identifier for this person
    NoteThis is a business identifier, not a resource identifier (see discussion)
    TypeIdentifier(Identifier, AU IHI, AU Medicare Card Number, AU DVA Number, AU Health Care Card Number, AU Pensioner Concession Card Number, AU Commonwealth Seniors Health Card Number, AU Medical Record Number, AU Insurance Member Number)
    12. RelatedPerson.relationship
    BindingUnless not suitable, these codes SHALL be taken from Related Person Relationship Type .
    (extensible to https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1)
    14. RelatedPerson.address
    Definition

    Address where the related person can be contacted or visited.

    ShortAddress where the related person can be contacted or visited
    Comments

    The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

    TypeAddress(Address, Australian Address)
    16. RelatedPerson.communication
    18. RelatedPerson.communication.language
    Definition

    A language which can be used to communicate with about the patient's health. The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

    BindingUnless not suitable, these codes SHALL be taken from Common Languages in Australia .
    (extensible to https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2)