Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft Australia flag

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

Resource Profile: ADHA MHR RelatedPerson

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-mhr-1 Version: 0.1.2
Draft as of 2024-09-12 Computable Name: ADHARelatedPersonMHR

Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The purpose of this profile is to define a representation of a related person for exchange usage scenarios with the My Health Record system infrastructure in Australia.

In the context of an exchange of health information a related person is part of the context established for a set of healthcare-related information.

This profile identifies the additional constraints, extensions, and value sets that build on and extend RelatedPerson that are supported.

A RelatedPerson resource is used within the context of a referencing resource.

This profile is designed to set a RelatedPerson standard:

  • Recording or updating a related person referenced by another resource in the context of the MHR system
  • Reading related persons referenced by another resource in the context of the MHR system

This profile may be referred to by APIs, which will be listed here when available.

Profile specific guidance

Boundaries and relationships

This profile is not referenced by another profile in this implementation guide.

Usage:

Formal Views of Profile Content

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

This structure is derived from ADHARelatedPersonCore

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C 0..* ADHARelatedPersonCore A person related to a patient in an Australian healthcare context
inv-dh-relper-03: At least one related person name shall have a family name
... identifier 1..* Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber A human identifier for this person
... patient 1..1 Reference(ADHA My Health Record Patient) The patient this person is related to
... name 1..* HumanName A name associated with the person

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-relper-03errorRelatedPersonAt least one related person name shall have a family name
: name.family.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C 0..* ADHARelatedPersonCore A person related to a patient in an Australian healthcare context
inv-relper-0: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
inv-relper-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
inv-relper-2: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply
inv-relper-3: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply
inv-relper-4: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply
inv-dh-relper-01: If present, name shall at least have text, family name, or given name
inv-dh-relper-03: At least one related person name shall have a family name
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... genderIdentity C 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... individualPronouns C 0..* (Complex) Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
.... recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:ihi SC 0..1 AUIHI Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
.... identifier:medicare S 0..1 AUMedicareCardNumber Medicare Card Number
.... identifier:dva S 0..1 AUDVANumber Department of Veterans' Affairs (DVA) Number
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
Fixed Value: true
... patient SΣC 1..1 Reference(ADHA My Health Record Patient) The patient this person is related to
inv-dh-relper-02: At least a reference, identifier or display shall be present
... relationship SΣ 1..* CodeableConcept The nature of the relationship
Binding: Related Person Relationship Type . (extensible)
... name SΣC 1..* HumanName A name associated with the person
... telecom SΣ 0..* ContactPoint A contact detail for the person
... address S 0..* Address, AustralianAddress Address where the related person can be contacted or visited
... communication S 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Common Languages in Australia . (extensible)
.... preferred S 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.relationshipextensibleRelatedPersonRelationshipType .
https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
RelatedPerson.communication.languageextensibleCommonLanguagesInAustralia .
https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-relper-03errorRelatedPersonAt least one related person name shall have a family name
: name.family.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C 0..* ADHARelatedPersonCore A person related to a patient in an Australian healthcare context
inv-relper-0: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
inv-relper-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
inv-relper-2: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply
inv-relper-3: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply
inv-relper-4: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply
inv-dh-relper-01: If present, name shall at least have text, family name, or given name
inv-dh-relper-03: At least one related person name shall have a family name
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... genderIdentity C 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... individualPronouns C 0..* (Complex) Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
.... recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber A human identifier for this person
Slice: Unordered, Open by pattern:type
.... identifier:ihi SC 0..1 AUIHI Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
.... identifier:medicare S 0..1 AUMedicareCardNumber Medicare Card Number
.... identifier:dva S 0..1 AUDVANumber Department of Veterans' Affairs (DVA) Number
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
Fixed Value: true
... patient SΣC 1..1 Reference(ADHA My Health Record Patient) The patient this person is related to
inv-dh-relper-02: At least a reference, identifier or display shall be present
... relationship SΣ 1..* CodeableConcept The nature of the relationship
Binding: Related Person Relationship Type . (extensible)
... name SΣC 1..* HumanName A name associated with the person
... telecom SΣ 0..* ContactPoint A contact detail for the person
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date on which the related person was born
... address S 0..* Address, AustralianAddress Address where the related person can be contacted or visited
... period 0..1 Period Period of time that this relationship is considered valid
... communication S 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Common Languages in Australia . (extensible)
.... preferred S 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
RelatedPerson.relationshipextensibleRelatedPersonRelationshipType .
https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
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
inv-dh-relper-03errorRelatedPersonAt least one related person name shall have a family name
: name.family.exists()

This structure is derived from ADHARelatedPersonCore

Summary

Mandatory: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from ADHARelatedPersonCore

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C 0..* ADHARelatedPersonCore A person related to a patient in an Australian healthcare context
inv-dh-relper-03: At least one related person name shall have a family name
... identifier 1..* Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber A human identifier for this person
... patient 1..1 Reference(ADHA My Health Record Patient) The patient this person is related to
... name 1..* HumanName A name associated with the person

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-relper-03errorRelatedPersonAt least one related person name shall have a family name
: name.family.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C 0..* ADHARelatedPersonCore A person related to a patient in an Australian healthcare context
inv-relper-0: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
inv-relper-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
inv-relper-2: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply
inv-relper-3: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply
inv-relper-4: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply
inv-dh-relper-01: If present, name shall at least have text, family name, or given name
inv-dh-relper-03: At least one related person name shall have a family name
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... genderIdentity C 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... individualPronouns C 0..* (Complex) Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
.... recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:ihi SC 0..1 AUIHI Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
.... identifier:medicare S 0..1 AUMedicareCardNumber Medicare Card Number
.... identifier:dva S 0..1 AUDVANumber Department of Veterans' Affairs (DVA) Number
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
Fixed Value: true
... patient SΣC 1..1 Reference(ADHA My Health Record Patient) The patient this person is related to
inv-dh-relper-02: At least a reference, identifier or display shall be present
... relationship SΣ 1..* CodeableConcept The nature of the relationship
Binding: Related Person Relationship Type . (extensible)
... name SΣC 1..* HumanName A name associated with the person
... telecom SΣ 0..* ContactPoint A contact detail for the person
... address S 0..* Address, AustralianAddress Address where the related person can be contacted or visited
... communication S 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Common Languages in Australia . (extensible)
.... preferred S 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.relationshipextensibleRelatedPersonRelationshipType .
https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
RelatedPerson.communication.languageextensibleCommonLanguagesInAustralia .
https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-relper-03errorRelatedPersonAt least one related person name shall have a family name
: name.family.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C 0..* ADHARelatedPersonCore A person related to a patient in an Australian healthcare context
inv-relper-0: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
inv-relper-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
inv-relper-2: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply
inv-relper-3: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply
inv-relper-4: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply
inv-dh-relper-01: If present, name shall at least have text, family name, or given name
inv-dh-relper-03: At least one related person name shall have a family name
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... genderIdentity C 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... individualPronouns C 0..* (Complex) Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
.... recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber A human identifier for this person
Slice: Unordered, Open by pattern:type
.... identifier:ihi SC 0..1 AUIHI Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
.... identifier:medicare S 0..1 AUMedicareCardNumber Medicare Card Number
.... identifier:dva S 0..1 AUDVANumber Department of Veterans' Affairs (DVA) Number
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
Fixed Value: true
... patient SΣC 1..1 Reference(ADHA My Health Record Patient) The patient this person is related to
inv-dh-relper-02: At least a reference, identifier or display shall be present
... relationship SΣ 1..* CodeableConcept The nature of the relationship
Binding: Related Person Relationship Type . (extensible)
... name SΣC 1..* HumanName A name associated with the person
... telecom SΣ 0..* ContactPoint A contact detail for the person
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date on which the related person was born
... address S 0..* Address, AustralianAddress Address where the related person can be contacted or visited
... period 0..1 Period Period of time that this relationship is considered valid
... communication S 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Common Languages in Australia . (extensible)
.... preferred S 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
RelatedPerson.relationshipextensibleRelatedPersonRelationshipType .
https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
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
inv-dh-relper-03errorRelatedPersonAt least one related person name shall have a family name
: name.family.exists()

This structure is derived from ADHARelatedPersonCore

Summary

Mandatory: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron

Notes:

No mandatory or optional search parameters for ADHA MHR RelatedPerson profile.