Australian Digital Health Agency FHIR Implementation Guide 1.1.0

This page is part of the Australian Digital Health Agency FHIR Implementation Guide 1.1.0. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available previous versions.

StructureDefinition: ADHA Core RelatedPerson [Active]

The purpose of this profile is to provide a core representation of a related person for the electronic exchange of health information between individuals, healthcare providers, and 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 core RelatedPerson standard for:

  • Recording or updating a related person referenced by another resource
  • Reading related persons referenced by another resource

Profile specific guidance

Boundaries and relationships

This profile is referenced by ADHA Core Condition, ADHA Core Encounter, ADHA Core Procedure.

The following profiles build on the ADHA Core RelatedPerson profile to define specific roles:

Formal Views of Profile Content

The official URL for this profile is: 

http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1

The purpose of this profile is to provide a core representation of a related person for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile builds on AUBaseRelatedPerson.

This profile was published on 2023-08-07 09:41:43+1000 as a active by Australian Digital Health Agency.

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*AUBaseRelatedPersonA person related to a patient in an Australian healthcare context
inv-dh-relper-01: If present, name shall at least have text, family name, or given name
... Slices for identifier S0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberA human identifier for this person
Slice: Unordered, Open by pattern:type
.... identifier:ihi S0..1AUIHIIndividual Healthcare Identifier (IHI)
.... identifier:medicare S0..1AUMedicareCardNumberMedicare Card Number
.... identifier:dva S0..1AUDVANumberDepartment of Veterans' Affairs (DVA) Number
... active 0..1booleanWhether this related person's record is in active use
Fixed Value: true
... patient SC1..1Reference(ADHA Core Patient)The patient this person is related to
inv-dh-relper-02: At least a reference, identifier or display shall be present
... relationship S1..*CodeableConceptThe nature of the relationship
... name SC0..*HumanNameA name associated with the person
... telecom S0..*ContactPointA contact detail for the person
... address S0..*Address, AustralianAddressAddress where the related person can be contacted or visited
... communication S0..*BackboneElementA language which may be used to communicate with about the patient's health
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
.... preferred S0..1booleanLanguage preference indicator

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*AUBaseRelatedPersonA person related to a patient in an Australian healthcare context
inv-dh-relper-01: If present, name shall at least have text, family name, or given name
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberA human identifier for this person
Slice: Unordered, Open by pattern:type
.... identifier:ihi SC0..1AUIHIIndividual Healthcare Identifier (IHI)
.... identifier:medicare S0..1AUMedicareCardNumberMedicare Card Number
.... identifier:dva S0..1AUDVANumberDepartment of Veterans' Affairs (DVA) Number
... active ?!Σ0..1booleanWhether this related person's record is in active use
Fixed Value: true
... patient SΣC1..1Reference(ADHA Core Patient)The patient this person is related to
inv-dh-relper-02: At least a reference, identifier or display shall be present
... relationship SΣ1..*CodeableConceptThe nature of the relationship
Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)
... name SΣC0..*HumanNameA name associated with the person
... telecom SΣ0..*ContactPointA contact detail for the person
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the related person was born
... address S0..*Address, AustralianAddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid
... communication S0..*BackboneElementA language which may be used to communicate with about the patient's health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
.... preferred S0..1booleanLanguage preference indicator

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*AUBaseRelatedPersonA person related to a patient in an Australian healthcare context
inv-dh-relper-01: If present, name shall at least have text, family name, or given name
... Slices for identifier S0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberA human identifier for this person
Slice: Unordered, Open by pattern:type
.... identifier:ihi S0..1AUIHIIndividual Healthcare Identifier (IHI)
.... identifier:medicare S0..1AUMedicareCardNumberMedicare Card Number
.... identifier:dva S0..1AUDVANumberDepartment of Veterans' Affairs (DVA) Number
... active 0..1booleanWhether this related person's record is in active use
Fixed Value: true
... patient SC1..1Reference(ADHA Core Patient)The patient this person is related to
inv-dh-relper-02: At least a reference, identifier or display shall be present
... relationship S1..*CodeableConceptThe nature of the relationship
... name SC0..*HumanNameA name associated with the person
... telecom S0..*ContactPointA contact detail for the person
... address S0..*Address, AustralianAddressAddress where the related person can be contacted or visited
... communication S0..*BackboneElementA language which may be used to communicate with about the patient's health
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
.... preferred S0..1booleanLanguage preference indicator

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*AUBaseRelatedPersonA person related to a patient in an Australian healthcare context
inv-dh-relper-01: If present, name shall at least have text, family name, or given name
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S0..*Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumberA human identifier for this person
Slice: Unordered, Open by pattern:type
.... identifier:ihi SC0..1AUIHIIndividual Healthcare Identifier (IHI)
.... identifier:medicare S0..1AUMedicareCardNumberMedicare Card Number
.... identifier:dva S0..1AUDVANumberDepartment of Veterans' Affairs (DVA) Number
... active ?!Σ0..1booleanWhether this related person's record is in active use
Fixed Value: true
... patient SΣC1..1Reference(ADHA Core Patient)The patient this person is related to
inv-dh-relper-02: At least a reference, identifier or display shall be present
... relationship SΣ1..*CodeableConceptThe nature of the relationship
Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible)
... name SΣC0..*HumanNameA name associated with the person
... telecom SΣ0..*ContactPointA contact detail for the person
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the related person was born
... address S0..*Address, AustralianAddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid
... communication S0..*BackboneElementA language which may be used to communicate with about the patient's health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
.... preferred S0..1booleanLanguage preference indicator

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.relationshipextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1
RelatedPerson.genderrequiredAdministrativeGender
RelatedPerson.communication.languageextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Search Parameters

None defined.