Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
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
| Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1 | Version: 1.0.1 | |||
| Active as of 2024-12-19 | Computable Name: ADHARelatedPersonCore | |||
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 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:
This profile may be referred to by APIs, which will be listed here when available.
The following profiles build on the ADHA Core RelatedPerson profile to define specific roles:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedPerson |
C | 0..* | AUBaseRelatedPerson | A 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 |
S | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person Slice: Unordered, Open by pattern:type |
   identifier:ihi |
S | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) |
| 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 |
SC | 1..1 | Reference(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..* | CodeableConcept | The nature of the relationship |
| name |
SC | 0..* | 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 |
 language |
S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health |
 preferred |
S | 0..1 | boolean | Language preference indicator |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-relper-01 | error | RelatedPerson | If present, name shall at least have text, family name, or given name : name.exists() implies name.all(text.exists() or family.exists() or given.exists()) | |
| inv-dh-relper-02 | error | RelatedPerson.patient | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson |
C | 0..* | AUBaseRelatedPerson | A person related to a patient in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for identifier |
S | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children |
| identifier:ihi |
SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children |
| identifier:dva |
S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number ele-1: All FHIR elements must have a @value or children |
| active |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use ele-1: All FHIR elements must have a @value or children Fixed Value: true |
| patient |
SΣC | 1..1 | Reference(ADHA Core Patient) | The patient this person is related to ele-1: All FHIR elements must have a @value or children 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)ele-1: All FHIR elements must have a @value or children |
| name |
SΣC | 0..* | HumanName | A name associated with the person ele-1: All FHIR elements must have a @value or children |
| telecom |
SΣ | 0..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children |
| address |
S | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited ele-1: All FHIR elements must have a @value or children |
| communication |
S | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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)ele-1: All FHIR elements must have a @value or children |
| preferred |
S | 0..1 | boolean | Language preference indicator ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship | extensible | RelatedPersonRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | |
| RelatedPerson.communication.language | extensible | CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-relper-01 | error | RelatedPerson | If present, name shall at least have text, family name, or given name : name.exists() implies name.all(text.exists() or family.exists() or given.exists()) | |
| inv-dh-relper-02 | error | RelatedPerson.patient | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
C | 0..* | AUBaseRelatedPerson | 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 | ||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | 0..* | 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 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..* | CodeableConcept | The nature of the relationship Binding: Related Person Relationship Type (extensible) | ||||
| name |
SΣC | 0..* | 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 | ||||
| photo |
0..* | Attachment | Image of the person | |||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| RelatedPerson.relationship | extensible | RelatedPersonRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | ||||
| RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| RelatedPerson.communication.language | extensible | CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-relper-01 | error | RelatedPerson | If present, name shall at least have text, family name, or given name : name.exists() implies name.all(text.exists() or family.exists() or given.exists()) | |
| inv-dh-relper-02 | error | RelatedPerson.patient | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
This structure is derived from AUBaseRelatedPerson
Summary
Mandatory: 1 element
Must-Support: 12 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AUBaseRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson |
C | 0..* | AUBaseRelatedPerson | A 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 |
S | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person Slice: Unordered, Open by pattern:type |
| identifier:ihi |
S | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) |
| 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 |
SC | 1..1 | Reference(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..* | CodeableConcept | The nature of the relationship |
| name |
SC | 0..* | 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 |
| language |
S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health |
| preferred |
S | 0..1 | boolean | Language preference indicator |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-relper-01 | error | RelatedPerson | If present, name shall at least have text, family name, or given name : name.exists() implies name.all(text.exists() or family.exists() or given.exists()) | |
| inv-dh-relper-02 | error | RelatedPerson.patient | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson |
C | 0..* | AUBaseRelatedPerson | A person related to a patient in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for identifier |
S | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children |
| identifier:ihi |
SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children |
| identifier:dva |
S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number ele-1: All FHIR elements must have a @value or children |
| active |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use ele-1: All FHIR elements must have a @value or children Fixed Value: true |
| patient |
SΣC | 1..1 | Reference(ADHA Core Patient) | The patient this person is related to ele-1: All FHIR elements must have a @value or children 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)ele-1: All FHIR elements must have a @value or children |
| name |
SΣC | 0..* | HumanName | A name associated with the person ele-1: All FHIR elements must have a @value or children |
| telecom |
SΣ | 0..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children |
| address |
S | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited ele-1: All FHIR elements must have a @value or children |
| communication |
S | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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)ele-1: All FHIR elements must have a @value or children |
| preferred |
S | 0..1 | boolean | Language preference indicator ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship | extensible | RelatedPersonRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | |
| RelatedPerson.communication.language | extensible | CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-relper-01 | error | RelatedPerson | If present, name shall at least have text, family name, or given name : name.exists() implies name.all(text.exists() or family.exists() or given.exists()) | |
| inv-dh-relper-02 | error | RelatedPerson.patient | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
C | 0..* | AUBaseRelatedPerson | 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 | ||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | 0..* | 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 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..* | CodeableConcept | The nature of the relationship Binding: Related Person Relationship Type (extensible) | ||||
| name |
SΣC | 0..* | 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 | ||||
| photo |
0..* | Attachment | Image of the person | |||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| RelatedPerson.relationship | extensible | RelatedPersonRelationshipType https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | ||||
| RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| RelatedPerson.communication.language | extensible | CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-relper-01 | error | RelatedPerson | If present, name shall at least have text, family name, or given name : name.exists() implies name.all(text.exists() or family.exists() or given.exists()) | |
| inv-dh-relper-02 | error | RelatedPerson.patient | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
This structure is derived from AUBaseRelatedPerson
Summary
Mandatory: 1 element
Must-Support: 12 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
No mandatory or optional search parameters for ADHA Core RelatedPerson profile.
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-12-19
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
