AU Core Implementation Guide
1.1.0-ci-build - CI Build Australia flag

AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/mjosborne1/mjo-au-fhir-core/ and changes regularly. See the Directory of published versions

Resource Profile: AU Core RelatedPerson

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson Version: 1.1.0-ci-build
Standards status: Trial-use Maturity Level: 0 Computable Name: AUCoreRelatedPerson

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a RelatedPerson resource to record, search, and fetch basic demographics and other administrative information about individual related persons associated with a patient. It is based on the AU Base Related Person profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the RelatedPerson resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

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

Usages:

Changes since version 1.0.0:

  • New Content

    • Formal Views of Profile Content

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

    This structure is derived from AUBaseRelatedPerson

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. RelatedPerson C 0..* AUBaseRelatedPerson A person related to a patient in an Australian healthcare context
    Constraints: au-core-relper-01, au-core-relper-02
    ... patient SO 1..1 Reference(AU Core Patient) The patient this person is related to
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... relationship SOC 0..* CodeableConcept The nature of the relationship
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... name SOC 0..* HumanName A name associated with the person
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... use SO 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... text SO 0..1 string Text representation of the full name
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... family SO 0..1 string Family name (often called 'Surname')
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... given SO 0..* string Given names (not always 'first'). Includes middle names
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... address SO 0..* Address, AustralianAddress Address where the related person can be contacted or visited
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Constraints

    IdGradePath(s)DetailsRequirements
    au-core-relper-01errorRelatedPersonEither a name or a relationship shall be provided (or both)
    : name.exists() or relationship.exists()
    au-core-relper-02errorRelatedPersonNames 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())
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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, au-core-relper-01, au-core-relper-02
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... Slices for extension Content/Rules for all slices
    .... 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
    .... 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
    .... 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
    URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... patient SOΣ 1..1 Reference(AU Core Patient) The patient this person is related to
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... relationship SOΣC 0..* CodeableConcept The nature of the relationship
    Binding: Related Person Relationship Type . (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... name SOΣC 0..* HumanName A name associated with the person
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... use ?!SOΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... text SOΣ 0..1 string Text representation of the full name
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... family SOΣ 0..1 string Family name (often called 'Surname')
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... given SOΣ 0..* string Given names (not always 'first'). Includes middle names
    This repeating element order: Given Names appear in the correct order for presenting the name
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... telecom SOΣ 0..* ContactPoint A contact detail for the person
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... address SOΣ 0..* Address, AustralianAddress Address where the related person can be contacted or visited
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    RelatedPerson.relationshipextensibleRelatedPersonRelationshipType .
    https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
    RelatedPerson.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    From the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    au-core-relper-01errorRelatedPersonEither a name or a relationship shall be provided (or both)
    : name.exists() or relationship.exists()
    au-core-relper-02errorRelatedPersonNames 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-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceRelatedPersonA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    inv-relper-0warningRelatedPersonIndividual 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-1warningRelatedPersonIndividual 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-2warningRelatedPersonRecorded 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-3warningRelatedPersonRecorded 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-4warningRelatedPersonRecorded 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'))
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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, au-core-relper-01, au-core-relper-02
    ... 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
    ... 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
    ... contained 0..* Resource Contained, inline Resources
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... 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
    .... 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
    .... 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
    URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
    ... 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 SOΣ 1..1 Reference(AU Core Patient) The patient this person is related to
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... relationship SOΣC 0..* CodeableConcept The nature of the relationship
    Binding: Related Person Relationship Type . (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... name SOΣC 0..* HumanName A name associated with the person
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... use ?!SOΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... text SOΣ 0..1 string Text representation of the full name
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... family SOΣ 0..1 string Family name (often called 'Surname')
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... given SOΣ 0..* string Given names (not always 'first'). Includes middle names
    This repeating element order: Given Names appear in the correct order for presenting the name
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... prefix Σ 0..* string Parts that come before the name
    This repeating element order: Prefixes appear in the correct order for presenting the name
    .... suffix Σ 0..* string Parts that come after the name
    This repeating element order: Suffixes appear in the correct order for presenting the name
    .... period Σ 0..1 Period Time period when name was/is in use
    ... telecom SOΣ 0..* ContactPoint A contact detail for the person
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... 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 SOΣ 0..* Address, AustralianAddress Address where the related person can be contacted or visited
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... 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: Common Languages in Australia . (extensible)
    .... preferred 0..1 boolean Language preference indicator

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    RelatedPerson.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    From the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    RelatedPerson.relationshipextensibleRelatedPersonRelationshipType .
    https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
    RelatedPerson.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    From the FHIR Standard
    RelatedPerson.genderrequiredAdministrativeGender
    http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
    From the FHIR Standard
    RelatedPerson.communication.languageextensibleCommonLanguagesInAustralia .
    https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

    Constraints

    IdGradePath(s)DetailsRequirements
    au-core-relper-01errorRelatedPersonEither a name or a relationship shall be provided (or both)
    : name.exists() or relationship.exists()
    au-core-relper-02errorRelatedPersonNames 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-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceRelatedPersonA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    inv-relper-0warningRelatedPersonIndividual 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-1warningRelatedPersonIndividual 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-2warningRelatedPersonRecorded 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-3warningRelatedPersonRecorded 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-4warningRelatedPersonRecorded 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'))

    This structure is derived from AUBaseRelatedPerson

    Summary

    Must-Support: 9 elements

    Structures

    This structure refers to these other structures:

    Maturity: 0

    Differential View

    This structure is derived from AUBaseRelatedPerson

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. RelatedPerson C 0..* AUBaseRelatedPerson A person related to a patient in an Australian healthcare context
    Constraints: au-core-relper-01, au-core-relper-02
    ... patient SO 1..1 Reference(AU Core Patient) The patient this person is related to
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... relationship SOC 0..* CodeableConcept The nature of the relationship
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... name SOC 0..* HumanName A name associated with the person
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... use SO 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... text SO 0..1 string Text representation of the full name
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... family SO 0..1 string Family name (often called 'Surname')
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... given SO 0..* string Given names (not always 'first'). Includes middle names
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... address SO 0..* Address, AustralianAddress Address where the related person can be contacted or visited
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Constraints

    IdGradePath(s)DetailsRequirements
    au-core-relper-01errorRelatedPersonEither a name or a relationship shall be provided (or both)
    : name.exists() or relationship.exists()
    au-core-relper-02errorRelatedPersonNames 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())

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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, au-core-relper-01, au-core-relper-02
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... Slices for extension Content/Rules for all slices
    .... 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
    .... 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
    .... 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
    URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... patient SOΣ 1..1 Reference(AU Core Patient) The patient this person is related to
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... relationship SOΣC 0..* CodeableConcept The nature of the relationship
    Binding: Related Person Relationship Type . (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... name SOΣC 0..* HumanName A name associated with the person
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... use ?!SOΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... text SOΣ 0..1 string Text representation of the full name
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... family SOΣ 0..1 string Family name (often called 'Surname')
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... given SOΣ 0..* string Given names (not always 'first'). Includes middle names
    This repeating element order: Given Names appear in the correct order for presenting the name
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... telecom SOΣ 0..* ContactPoint A contact detail for the person
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... address SOΣ 0..* Address, AustralianAddress Address where the related person can be contacted or visited
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    RelatedPerson.relationshipextensibleRelatedPersonRelationshipType .
    https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
    RelatedPerson.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    From the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    au-core-relper-01errorRelatedPersonEither a name or a relationship shall be provided (or both)
    : name.exists() or relationship.exists()
    au-core-relper-02errorRelatedPersonNames 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-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceRelatedPersonA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    inv-relper-0warningRelatedPersonIndividual 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-1warningRelatedPersonIndividual 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-2warningRelatedPersonRecorded 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-3warningRelatedPersonRecorded 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-4warningRelatedPersonRecorded 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'))

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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, au-core-relper-01, au-core-relper-02
    ... 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
    ... 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
    ... contained 0..* Resource Contained, inline Resources
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... 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
    .... 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
    .... 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
    URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
    ... 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 SOΣ 1..1 Reference(AU Core Patient) The patient this person is related to
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... relationship SOΣC 0..* CodeableConcept The nature of the relationship
    Binding: Related Person Relationship Type . (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... name SOΣC 0..* HumanName A name associated with the person
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... use ?!SOΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... text SOΣ 0..1 string Text representation of the full name
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... family SOΣ 0..1 string Family name (often called 'Surname')
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... given SOΣ 0..* string Given names (not always 'first'). Includes middle names
    This repeating element order: Given Names appear in the correct order for presenting the name
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... prefix Σ 0..* string Parts that come before the name
    This repeating element order: Prefixes appear in the correct order for presenting the name
    .... suffix Σ 0..* string Parts that come after the name
    This repeating element order: Suffixes appear in the correct order for presenting the name
    .... period Σ 0..1 Period Time period when name was/is in use
    ... telecom SOΣ 0..* ContactPoint A contact detail for the person
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... 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 SOΣ 0..* Address, AustralianAddress Address where the related person can be contacted or visited
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... 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: Common Languages in Australia . (extensible)
    .... preferred 0..1 boolean Language preference indicator

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    RelatedPerson.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    From the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    RelatedPerson.relationshipextensibleRelatedPersonRelationshipType .
    https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
    RelatedPerson.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    From the FHIR Standard
    RelatedPerson.genderrequiredAdministrativeGender
    http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
    From the FHIR Standard
    RelatedPerson.communication.languageextensibleCommonLanguagesInAustralia .
    https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

    Constraints

    IdGradePath(s)DetailsRequirements
    au-core-relper-01errorRelatedPersonEither a name or a relationship shall be provided (or both)
    : name.exists() or relationship.exists()
    au-core-relper-02errorRelatedPersonNames 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-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceRelatedPersonA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    inv-relper-0warningRelatedPersonIndividual 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-1warningRelatedPersonIndividual 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-2warningRelatedPersonRecorded 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-3warningRelatedPersonRecorded 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-4warningRelatedPersonRecorded 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'))

    This structure is derived from AUBaseRelatedPerson

    Summary

    Must-Support: 9 elements

    Structures

    This structure refers to these other structures:

    Maturity: 0

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:

    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.

    Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
    patient SHALL reference The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both.

    The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
    _id SHOULD token
    patient+relationship SHOULD reference+token
    patient+name SHOULD reference+string
    name MAY string
    relationship MAY token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both.

    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,http://snomed.info/sct|133932002
      2. GET [base]/RelatedPerson?patient.identifier=http://example.org/fhir/mrn|12345&relationship=http://terminology.hl7.org/CodeSystem/v3-RoleCode|MTH,http://snomed.info/sct|133932002

      Implementation Notes: Fetches a bundle of all RelatedPerson resources for the specified patient and relationship code (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)