AU Base Implementation Guide
4.1.0-ballot - CI Build
AU
This page is part of AU Base v4.1.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org.au/fhir/StructureDefinition/au-relatedperson | Version: 4.1.0-ballot | |||
Active as of 2022-11-10 | Maturity Level: 2 | Computable Name: AUBaseRelatedPerson | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
This profile defines a related person structure that localises core concepts, including identifiers and terminology, for use in an Australian context.
The purpose of this profile is to provide national level agreement on core localised concepts.
This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.
Multiple Individual Healthcare Identifiers are supported particularly to support the recording of IHI values where the status and/or record status varies (e.g. deceased, provisional).
Medicare Number is defined as a 10 or 11 digit number. Whilst 10 digits is not sufficient to uniquely identify an individual it is a supported entry where systems do not support 11 digit content. If required profiles can constrain this slice further to restrict usage to 11 digits only as desired. Medicare Numbers are not used for uniquely identifying patients, they are identifying information that can be used in conjunction with other elements such as name and date of birth appropriately to confirm identity.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RelatedPerson
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person related to a patient in an Australian healthcare context | |
identifier | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person | |
relationship | 0..* | CodeableConcept | The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible) | |
address | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited | |
communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |
language | 1..1 | CodeableConcept | The 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) | |
Documentation for this format |
Path | Conformance | ValueSet |
RelatedPerson.relationship | extensible | https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 |
RelatedPerson.communication.language | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person related to a patient in an Australian healthcare context | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
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 | Σ | 1..1 | Reference(Patient) | The patient this person is related to |
relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible) |
address | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited | |
communication | 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 | 1..1 | CodeableConcept | The 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) | |
Documentation for this format |
Path | Conformance | ValueSet |
RelatedPerson.relationship | extensible | https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 |
RelatedPerson.communication.language | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person related to a patient in an Australian healthcare context | |||||
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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 | Σ | 1..1 | Reference(Patient) | The patient this person is related to | ||||
relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible) | ||||
name | Σ | 0..* | HumanName | A name associated with the person | ||||
telecom | Σ | 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 | 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 | 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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
RelatedPerson.language | preferred | CommonLanguages
| ||||
RelatedPerson.relationship | extensible | https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | ||||
RelatedPerson.gender | required | AdministrativeGender | ||||
RelatedPerson.communication.language | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
This structure is derived from RelatedPerson
Differential View
This structure is derived from RelatedPerson
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person related to a patient in an Australian healthcare context | |
identifier | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person | |
relationship | 0..* | CodeableConcept | The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible) | |
address | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited | |
communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |
language | 1..1 | CodeableConcept | The 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) | |
Documentation for this format |
Path | Conformance | ValueSet |
RelatedPerson.relationship | extensible | https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 |
RelatedPerson.communication.language | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person related to a patient in an Australian healthcare context | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
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 | Σ | 1..1 | Reference(Patient) | The patient this person is related to |
relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible) |
address | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited | |
communication | 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 | 1..1 | CodeableConcept | The 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) | |
Documentation for this format |
Path | Conformance | ValueSet |
RelatedPerson.relationship | extensible | https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 |
RelatedPerson.communication.language | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person related to a patient in an Australian healthcare context | |||||
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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 | Σ | 1..1 | Reference(Patient) | The patient this person is related to | ||||
relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible) | ||||
name | Σ | 0..* | HumanName | A name associated with the person | ||||
telecom | Σ | 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 | 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 | 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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
RelatedPerson.language | preferred | CommonLanguages
| ||||
RelatedPerson.relationship | extensible | https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | ||||
RelatedPerson.gender | required | AdministrativeGender | ||||
RelatedPerson.communication.language | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
This structure is derived from RelatedPerson
Other representations of profile: CSV, Excel, Schematron
none defined