Helix AU Core
0.1.0 - ci-build
Helix AU Core - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://medicaldirector.com/fhir/helix-au-core/StructureDefinition/HelixAUCoreRelatedPerson | Version: 0.1.0 | |||
| Draft as of 2025-12-09 | Computable Name: HelixAUCoreRelatedPerson | |||
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AUCoreRelatedPerson | A person related to a patient in an Australian healthcare context Constraints: au-core-relper-01 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
S | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() |
SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) Constraints: inv-ihi-value-0, inv-ihi-value-1, inv-ihi-value-2 |
![]() ![]() ![]() |
S | 0..1 | AUMedicareCardNumber | Medicare Card Number |
![]() ![]() ![]() |
S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number |
![]() ![]() ![]() |
S | 1..1 | HelixBaseAuthoringKey | A human identifier for this person |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use Fixed Value: true |
![]() ![]() |
SΣ | 1..1 | Reference(AU Core Patient) | The patient this person is related to |
![]() ![]() |
SΣ | 1..* | CodeableConcept | The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible) |
![]() ![]() |
SΣC | 0..* | HumanName | A name associated with the person |
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() |
S | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited |
![]() ![]() |
S | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 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) |
![]() ![]() ![]() |
S | 0..1 | boolean | Language preference indicator |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.relationship | Base | extensible | https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | Not State | Unknown |
| RelatedPerson.communication.language | Base | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| au-core-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())
|
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | 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 |
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-4 | error | RelatedPerson | If 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-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-ihi-value-0 | error | RelatedPerson.identifier:ihi | IHI shall be an exactly 16 digit number |
value.matches('^([0-9]{16})$')
|
| inv-ihi-value-1 | error | RelatedPerson.identifier:ihi | IHI prefix is 800360 |
value.startsWith('800360')
|
| inv-ihi-value-2 | error | RelatedPerson.identifier:ihi | IHI shall pass the Luhn algorithm check |
(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
|
This structure is derived from AUCoreRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUCoreRelatedPerson | A person related to a patient in an Australian healthcare context | |
![]() ![]() |
1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 1..1 | HelixBaseAuthoringKey | A human identifier for this person |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AUCoreRelatedPerson | A person related to a patient in an Australian healthcare context Constraints: au-core-relper-01 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
S | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person Slice: Unordered, Open by pattern:type | ||||
![]() ![]() ![]() |
SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) Constraints: inv-ihi-value-0, inv-ihi-value-1, inv-ihi-value-2 | ||||
![]() ![]() ![]() |
S | 0..1 | AUMedicareCardNumber | Medicare Card Number | ||||
![]() ![]() ![]() |
S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number | ||||
![]() ![]() ![]() |
S | 1..1 | HelixBaseAuthoringKey | A human identifier for this person | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use Fixed Value: true | ||||
![]() ![]() |
SΣ | 1..1 | Reference(AU Core Patient) | The patient this person is related to | ||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible) | ||||
![]() ![]() |
SΣC | 0..* | HumanName | A name associated with the person | ||||
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
Σ | 0..1 | date | The date on which the related person was born | ||||
![]() ![]() |
S | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited | ||||
![]() ![]() |
0..* | Attachment | Image of the person | |||||
![]() ![]() |
0..1 | Period | Period of time that this relationship is considered valid | |||||
![]() ![]() |
S | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 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) | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | Language preference indicator | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | extensible | https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | Not State | Unknown |
| RelatedPerson.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| RelatedPerson.communication.language | Base | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| au-core-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())
|
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | 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 |
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-4 | error | RelatedPerson | If 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-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-ihi-value-0 | error | RelatedPerson.identifier:ihi | IHI shall be an exactly 16 digit number |
value.matches('^([0-9]{16})$')
|
| inv-ihi-value-1 | error | RelatedPerson.identifier:ihi | IHI prefix is 800360 |
value.startsWith('800360')
|
| inv-ihi-value-2 | error | RelatedPerson.identifier:ihi | IHI shall pass the Luhn algorithm check |
(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
|
This structure is derived from AUCoreRelatedPerson
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AUCoreRelatedPerson | A person related to a patient in an Australian healthcare context Constraints: au-core-relper-01 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
S | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() |
SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) Constraints: inv-ihi-value-0, inv-ihi-value-1, inv-ihi-value-2 |
![]() ![]() ![]() |
S | 0..1 | AUMedicareCardNumber | Medicare Card Number |
![]() ![]() ![]() |
S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number |
![]() ![]() ![]() |
S | 1..1 | HelixBaseAuthoringKey | A human identifier for this person |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use Fixed Value: true |
![]() ![]() |
SΣ | 1..1 | Reference(AU Core Patient) | The patient this person is related to |
![]() ![]() |
SΣ | 1..* | CodeableConcept | The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible) |
![]() ![]() |
SΣC | 0..* | HumanName | A name associated with the person |
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() |
S | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited |
![]() ![]() |
S | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 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) |
![]() ![]() ![]() |
S | 0..1 | boolean | Language preference indicator |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.relationship | Base | extensible | https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | Not State | Unknown |
| RelatedPerson.communication.language | Base | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| au-core-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())
|
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | 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 |
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-4 | error | RelatedPerson | If 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-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-ihi-value-0 | error | RelatedPerson.identifier:ihi | IHI shall be an exactly 16 digit number |
value.matches('^([0-9]{16})$')
|
| inv-ihi-value-1 | error | RelatedPerson.identifier:ihi | IHI prefix is 800360 |
value.startsWith('800360')
|
| inv-ihi-value-2 | error | RelatedPerson.identifier:ihi | IHI shall pass the Luhn algorithm check |
(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
|
Differential View
This structure is derived from AUCoreRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUCoreRelatedPerson | A person related to a patient in an Australian healthcare context | |
![]() ![]() |
1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 1..1 | HelixBaseAuthoringKey | A human identifier for this person |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AUCoreRelatedPerson | A person related to a patient in an Australian healthcare context Constraints: au-core-relper-01 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
S | 1..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person Slice: Unordered, Open by pattern:type | ||||
![]() ![]() ![]() |
SC | 0..1 | AUIHI | Individual Healthcare Identifier (IHI) Constraints: inv-ihi-value-0, inv-ihi-value-1, inv-ihi-value-2 | ||||
![]() ![]() ![]() |
S | 0..1 | AUMedicareCardNumber | Medicare Card Number | ||||
![]() ![]() ![]() |
S | 0..1 | AUDVANumber | Department of Veterans' Affairs (DVA) Number | ||||
![]() ![]() ![]() |
S | 1..1 | HelixBaseAuthoringKey | A human identifier for this person | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use Fixed Value: true | ||||
![]() ![]() |
SΣ | 1..1 | Reference(AU Core Patient) | The patient this person is related to | ||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | The nature of the relationship Binding: https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 (extensible) | ||||
![]() ![]() |
SΣC | 0..* | HumanName | A name associated with the person | ||||
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
Σ | 0..1 | date | The date on which the related person was born | ||||
![]() ![]() |
S | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited | ||||
![]() ![]() |
0..* | Attachment | Image of the person | |||||
![]() ![]() |
0..1 | Period | Period of time that this relationship is considered valid | |||||
![]() ![]() |
S | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 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) | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | Language preference indicator | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | extensible | https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | Not State | Unknown |
| RelatedPerson.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| RelatedPerson.communication.language | Base | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| au-core-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())
|
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | 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 |
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-4 | error | RelatedPerson | If 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-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-ihi-value-0 | error | RelatedPerson.identifier:ihi | IHI shall be an exactly 16 digit number |
value.matches('^([0-9]{16})$')
|
| inv-ihi-value-1 | error | RelatedPerson.identifier:ihi | IHI prefix is 800360 |
value.startsWith('800360')
|
| inv-ihi-value-2 | error | RelatedPerson.identifier:ihi | IHI shall pass the Luhn algorithm check |
(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
|
This structure is derived from AUCoreRelatedPerson
Other representations of profile: CSV, Excel, Schematron