AU Patient Summary Implementation Guide
0.5.0-cibuild - CI Build
AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.5.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-ps/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson | Version: 0.5.0-cibuild | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: AUPSRelatedPerson | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
This profile sets minimum expectations for a RelatedPerson resource in the context of a patient summary in an Australian context. It is based on the AU Core Related Person profile, and applies the additional constraints for use in a patient summary context consistent with the profiling conventions of IPS.
See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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 | |||||||||
![]() ![]() ![]() |
O | 1..1 | Reference(AU PS Patient) | The patient this person is related to
| ||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
![]() ![]() ![]() |
O | 0..* | CodeableConceptIPS | The nature of the relationship
| ||||||||
![]() ![]() ![]() |
O | 0..* | HumanName | A name associated with the person
| ||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
| ||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | string | Text representation of the full name
| ||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | string | Family name (often called 'Surname')
| ||||||||
![]() ![]() ![]() ![]() |
O | 0..* | string | Given names (not always 'first'). Includes middle names
| ||||||||
![]() ![]() ![]() |
O | 0..* | ContactPoint | A contact detail for the person
| ||||||||
![]() ![]() ![]() |
O | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited
| ||||||||
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUCoreRelatedPerson | A person related to a patient in an Australian healthcare context Constraints: inv-relper-0, inv-relper-1, inv-relper-2, inv-relper-3, inv-relper-4, au-core-relper-01, au-core-relper-02 | ||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU PS Patient) | The patient this person is related to
| ||||||||
![]() ![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
![]() ![]() ![]() |
SOΣC | 0..* | CodeableConceptIPS | The nature of the relationship Binding: Related Person Relationship Type ![]()
| ||||||||
![]() ![]() ![]() |
SOΣC | 0..* | HumanName | A name associated with the person
| ||||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||||
![]() ![]() ![]() |
SOΣ | 0..* | ContactPoint | A contact detail for the person
| ||||||||
![]() ![]() ![]() |
SOΣ | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited
| ||||||||
![]() |
Path | Conformance | ValueSet | URI |
RelatedPerson.relationship | extensible | RelatedPersonRelationshipType ![]() https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | |
RelatedPerson.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
au-core-relper-01 | error | RelatedPerson | Either a name or a relationship shall be provided (or both) : name.exists() or relationship.exists() | |
au-core-relper-02 | error | RelatedPerson | Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present : name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor 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-relper-0 | warning | RelatedPerson | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-relper-1 | warning | RelatedPerson | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) | |
inv-relper-2 | warning | RelatedPerson | 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 : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) | |
inv-relper-3 | warning | RelatedPerson | 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 : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) | |
inv-relper-4 | warning | RelatedPerson | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUCoreRelatedPerson | A person related to a patient in an Australian healthcare context Constraints: inv-relper-0, inv-relper-1, inv-relper-2, inv-relper-3, inv-relper-4, au-core-relper-01, au-core-relper-02 | ||||||||
![]() ![]() ![]() |
Σ | 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 | Extension Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person | ||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU PS Patient) | The patient this person is related to
| ||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
![]() ![]() ![]() |
SOΣC | 0..* | CodeableConceptIPS | The nature of the relationship Binding: Related Person Relationship Type ![]()
| ||||||||
![]() ![]() ![]() |
SOΣC | 0..* | HumanName | A name associated with the person
| ||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||||||
![]() ![]() ![]() |
SOΣ | 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 | ||||||||
![]() ![]() ![]() |
SOΣ | 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 | |||||||||
![]() ![]() ![]() |
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 | ||||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia ![]() | |||||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||||||
![]() |
Path | Conformance | ValueSet | URI | |||
RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
RelatedPerson.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | ||||
RelatedPerson.relationship | extensible | RelatedPersonRelationshipType ![]() https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | ||||
RelatedPerson.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard | ||||
RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard | ||||
RelatedPerson.communication.language | extensible | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
Id | Grade | Path(s) | Details | Requirements |
au-core-relper-01 | error | RelatedPerson | Either a name or a relationship shall be provided (or both) : name.exists() or relationship.exists() | |
au-core-relper-02 | error | RelatedPerson | Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present : name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor 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-relper-0 | warning | RelatedPerson | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-relper-1 | warning | RelatedPerson | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) | |
inv-relper-2 | warning | RelatedPerson | 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 : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) | |
inv-relper-3 | warning | RelatedPerson | 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 : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) | |
inv-relper-4 | warning | RelatedPerson | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
This structure is derived from AUCoreRelatedPerson
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Maturity: 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 | |||||||||
![]() ![]() ![]() |
O | 1..1 | Reference(AU PS Patient) | The patient this person is related to
| ||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
![]() ![]() ![]() |
O | 0..* | CodeableConceptIPS | The nature of the relationship
| ||||||||
![]() ![]() ![]() |
O | 0..* | HumanName | A name associated with the person
| ||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
| ||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | string | Text representation of the full name
| ||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | string | Family name (often called 'Surname')
| ||||||||
![]() ![]() ![]() ![]() |
O | 0..* | string | Given names (not always 'first'). Includes middle names
| ||||||||
![]() ![]() ![]() |
O | 0..* | ContactPoint | A contact detail for the person
| ||||||||
![]() ![]() ![]() |
O | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited
| ||||||||
![]() |
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: inv-relper-0, inv-relper-1, inv-relper-2, inv-relper-3, inv-relper-4, au-core-relper-01, au-core-relper-02 | ||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU PS Patient) | The patient this person is related to
| ||||||||
![]() ![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
![]() ![]() ![]() |
SOΣC | 0..* | CodeableConceptIPS | The nature of the relationship Binding: Related Person Relationship Type ![]()
| ||||||||
![]() ![]() ![]() |
SOΣC | 0..* | HumanName | A name associated with the person
| ||||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||||
![]() ![]() ![]() |
SOΣ | 0..* | ContactPoint | A contact detail for the person
| ||||||||
![]() ![]() ![]() |
SOΣ | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited
| ||||||||
![]() |
Path | Conformance | ValueSet | URI |
RelatedPerson.relationship | extensible | RelatedPersonRelationshipType ![]() https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | |
RelatedPerson.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
au-core-relper-01 | error | RelatedPerson | Either a name or a relationship shall be provided (or both) : name.exists() or relationship.exists() | |
au-core-relper-02 | error | RelatedPerson | Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present : name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor 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-relper-0 | warning | RelatedPerson | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-relper-1 | warning | RelatedPerson | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) | |
inv-relper-2 | warning | RelatedPerson | 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 : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) | |
inv-relper-3 | warning | RelatedPerson | 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 : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) | |
inv-relper-4 | warning | RelatedPerson | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUCoreRelatedPerson | A person related to a patient in an Australian healthcare context Constraints: inv-relper-0, inv-relper-1, inv-relper-2, inv-relper-3, inv-relper-4, au-core-relper-01, au-core-relper-02 | ||||||||
![]() ![]() ![]() |
Σ | 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 | Extension Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person | ||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU PS Patient) | The patient this person is related to
| ||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
![]() ![]() ![]() |
SOΣC | 0..* | CodeableConceptIPS | The nature of the relationship Binding: Related Person Relationship Type ![]()
| ||||||||
![]() ![]() ![]() |
SOΣC | 0..* | HumanName | A name associated with the person
| ||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||||||
![]() ![]() ![]() |
SOΣ | 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 | ||||||||
![]() ![]() ![]() |
SOΣ | 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 | |||||||||
![]() ![]() ![]() |
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 | ||||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia ![]() | |||||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||||||
![]() |
Path | Conformance | ValueSet | URI | |||
RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
RelatedPerson.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | ||||
RelatedPerson.relationship | extensible | RelatedPersonRelationshipType ![]() https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | ||||
RelatedPerson.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard | ||||
RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard | ||||
RelatedPerson.communication.language | extensible | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
Id | Grade | Path(s) | Details | Requirements |
au-core-relper-01 | error | RelatedPerson | Either a name or a relationship shall be provided (or both) : name.exists() or relationship.exists() | |
au-core-relper-02 | error | RelatedPerson | Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present : name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor 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-relper-0 | warning | RelatedPerson | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-relper-1 | warning | RelatedPerson | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) | |
inv-relper-2 | warning | RelatedPerson | 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 : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) | |
inv-relper-3 | warning | RelatedPerson | 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 : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) | |
inv-relper-4 | warning | RelatedPerson | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
This structure is derived from AUCoreRelatedPerson
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron