AU Patient Summary Implementation Guide
0.5.0-cibuild - CI Build Australia flag

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

Resource Profile: AUPSRelatedPerson - Detailed Descriptions

Page standards status: Draft Maturity Level: 0

Definitions for the au-ps-relatedperson resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. RelatedPerson
2. RelatedPerson.patient
TypeReference(AU PS Patient)
Obligations
    ObligationsActor
    SHALL:populate-if-knownAU PS Producer
    SHALL:handleAU PS Consumer
    SHOULD:displayAU PS Consumer
    4. RelatedPerson.patient.reference
    Control1..?
    Must Supporttrue
    Obligations
      ObligationsActor
      SHALL:populate-if-knownAU PS Producer
      SHALL:handleAU PS Consumer
      SHOULD:displayAU PS Consumer
      6. RelatedPerson.relationship
      TypeCodeableConcept(Codeable Concept (IPS))
      Obligations
        ObligationsActor
        SHALL:populate-if-knownAU PS Producer
        SHALL:handleAU PS Consumer
        SHOULD:displayAU PS Consumer
        8. RelatedPerson.name
        Obligations
          ObligationsActor
          SHALL:populate-if-knownAU PS Producer
          SHALL:handleAU PS Consumer
          SHOULD:displayAU PS Consumer
          10. RelatedPerson.name.use
          Obligations
            ObligationsActor
            SHALL:populate-if-knownAU PS Producer
            SHALL:handleAU PS Consumer
            SHOULD:displayAU PS Consumer
            12. RelatedPerson.name.text
            Obligations
              ObligationsActor
              SHALL:populate-if-knownAU PS Producer
              SHALL:handleAU PS Consumer
              SHOULD:displayAU PS Consumer
              14. RelatedPerson.name.family
              Obligations
                ObligationsActor
                SHALL:populate-if-knownAU PS Producer
                SHALL:handleAU PS Consumer
                SHOULD:displayAU PS Consumer
                16. RelatedPerson.name.given
                Obligations
                  ObligationsActor
                  SHALL:populate-if-knownAU PS Producer
                  SHALL:handleAU PS Consumer
                  SHOULD:displayAU PS Consumer
                  18. RelatedPerson.telecom
                  Obligations
                    ObligationsActor
                    SHALL:populate-if-knownAU PS Producer
                    SHALL:handleAU PS Consumer
                    SHOULD:displayAU PS Consumer
                    20. RelatedPerson.address
                    Obligations
                      ObligationsActor
                      SHALL:populate-if-knownAU PS Producer
                      SHALL:handleAU PS Consumer
                      SHOULD:displayAU PS Consumer

                      Guidance on how to interpret the contents of this table can be foundhere

                      0. RelatedPerson
                      Definition

                      Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

                      ShortA person related to a patient in an Australian healthcare contextA person that is related to a patient, but who is not a direct target of care
                      Control0..*
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                      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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                      dom-6: A resource should have narrative for robust management (text.`div`.exists())
                      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 (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: 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: 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: 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: 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')))
                      au-core-relper-01: Either a name or a relationship shall be provided (or both) (name.exists() or relationship.exists())
                      au-core-relper-02: 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()))
                      2. RelatedPerson.implicitRules
                      Definition

                      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                      ShortA set of rules under which this content was created
                      Comments

                      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                      Control0..1
                      Typeuri
                      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      4. RelatedPerson.extension:genderIdentity
                      Slice NamegenderIdentity
                      Definition

                      An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else.

                      ShortGender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
                      Comments

                      The individual's gender identity is populated in the extension:value.value[x] of the Individual Gender Identity extension and shall contain one of the codes from the Gender Identity Response value set if any of the codes within the value set can apply.

                      See Australian Bureau of Statics (ABS) Standard for Sex, Gender, Variations of Sex Characteristics and Sexual Orientation Variables, 2020 for further materials.

                      Control0..*
                      This element is affected by the following invariants: inv-relper-0
                      TypeExtension(Individual Gender Identity) (Complex Extension)
                      Is Modifierfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      6. RelatedPerson.extension:individualPronouns
                      Slice NameindividualPronouns
                      Definition

                      The pronouns to use when referring to an individual in verbal or written communication.

                      ShortPronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
                      Comments

                      The individual's pronouns are populated in the extension:value.value[x] of the Individual Pronouns extension and shall contain one of the codes from the Australian Pronouns value set if any of the codes within the value set can apply.

                      Control0..*
                      This element is affected by the following invariants: inv-relper-1
                      TypeExtension(Individual Pronouns) (Complex Extension)
                      Is Modifierfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      8. RelatedPerson.extension:recordedSexOrGender
                      Slice NamerecordedSexOrGender
                      Definition

                      A sex or gender property for the individual from a document or other record

                      ShortRecorded 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
                      Comments

                      The type of recorded sex or gender is populated in the extension:type.value[x] of the Person Recorded Sex or Gender extension and shall contain one of the codes from the AU Recorded Sex or Gender Type value set if any of the codes within the value set can apply.

                      The document from which the sex or gender property was acquired is populated in the extension:sourceDocument.value[x] of the Person Recorded Sex or Gender extension and shall contain one of the codes from the AU Recorded Sex or Gender (RSG) Source Document Type value set if any of the codes within the value set can apply.

                      The jurisdiction that issued the document where the sex or gender was acquired is populated in the extension:jurisdiction.value[x] of the Person Recorded Sex or Gender extension and shall contain one of the codes from the Jurisdiction ValueSet - AU Extended value set if any of the codes within the value set can apply.

                      Control0..*
                      This element is affected by the following invariants: inv-relper-2, inv-relper-3, inv-relper-4
                      TypeExtension(Person Recorded Sex Or Gender) (Complex Extension)
                      Is Modifierfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      10. RelatedPerson.modifierExtension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                      ShortExtensions that cannot be ignored
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                      Summaryfalse
                      Requirements

                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      12. RelatedPerson.active
                      Definition

                      Whether this related person record is in active use.

                      ShortWhether this related person's record is in active use
                      Comments

                      This element is labeled as a modifier because it may be used to mark that the resource was created in error.

                      Control0..1
                      Typeboolean
                      Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to be able to mark a related person record as not to be used, such as if it was created in error.

                      Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      14. RelatedPerson.patient
                      Definition

                      The patient this person is related to.

                      ShortThe patient this person is related to
                      Control1..1
                      TypeReference(AU PS Patient, Patient)
                      Is Modifierfalse
                      Must Supporttrue
                      Obligations
                        ObligationsActor
                        SHALL:populate-if-knownAU PS Producer
                        SHALL:handleAU PS Consumer
                        SHOULD:displayAU PS Consumer
                        Summarytrue
                        Requirements

                        We need to know which patient this RelatedPerson is related to.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        16. RelatedPerson.patient.reference
                        Definition

                        A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                        ShortLiteral reference, Relative, internal or absolute URL
                        Comments

                        Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                        Control10..1
                        This element is affected by the following invariants: ref-1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Obligations
                          ObligationsActor
                          SHALL:populate-if-knownAU PS Producer
                          SHALL:handleAU PS Consumer
                          SHOULD:displayAU PS Consumer
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          18. RelatedPerson.relationship
                          Definition

                          The nature of the relationship between a patient and the related person.

                          ShortThe nature of the relationship
                          Control0..*
                          This element is affected by the following invariants: au-core-relper-01
                          BindingUnless not suitable, these codes SHALL be taken from The codes SHOULD be taken from Related Person Relationship Type .http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
                          (extensible to https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1)
                          TypeCodeableConcept(Codeable Concept (IPS))
                          Is Modifierfalse
                          Must Supporttrue
                          Obligations
                            ObligationsActor
                            SHALL:populate-if-knownAU PS Producer
                            SHALL:handleAU PS Consumer
                            SHOULD:displayAU PS Consumer
                            Summarytrue
                            Requirements

                            We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            20. RelatedPerson.name
                            Definition

                            A name associated with the person.

                            ShortA name associated with the person
                            Control0..*
                            This element is affected by the following invariants: au-core-relper-01
                            TypeHumanName
                            Is Modifierfalse
                            Must Supporttrue
                            Obligations
                              ObligationsActor
                              SHALL:populate-if-knownAU PS Producer
                              SHALL:handleAU PS Consumer
                              SHOULD:displayAU PS Consumer
                              Summarytrue
                              Requirements

                              Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              22. RelatedPerson.name.use
                              Definition

                              Identifies the purpose for this name.

                              Shortusual | official | temp | nickname | anonymous | old | maiden
                              Comments

                              Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                              Control0..1
                              BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1
                              (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                              The use of a human name.

                              Typecode
                              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Obligations
                                ObligationsActor
                                SHALL:populate-if-knownAU PS Producer
                                SHALL:handleAU PS Consumer
                                SHOULD:displayAU PS Consumer
                                Summarytrue
                                Requirements

                                Allows the appropriate name for a particular context of use to be selected from among a set of names.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                24. RelatedPerson.name.text
                                Definition

                                Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                                ShortText representation of the full name
                                Comments

                                Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Obligations
                                  ObligationsActor
                                  SHALL:populate-if-knownAU PS Producer
                                  SHALL:handleAU PS Consumer
                                  SHOULD:displayAU PS Consumer
                                  Summarytrue
                                  Requirements

                                  A renderable, unencoded form.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  26. RelatedPerson.name.family
                                  Definition

                                  The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                  ShortFamily name (often called 'Surname')
                                  Comments

                                  Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Obligations
                                    ObligationsActor
                                    SHALL:populate-if-knownAU PS Producer
                                    SHALL:handleAU PS Consumer
                                    SHOULD:displayAU PS Consumer
                                    Summarytrue
                                    Alternate Namessurname
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    28. RelatedPerson.name.given
                                    Definition

                                    Given name.

                                    ShortGiven names (not always 'first'). Includes middle names
                                    Comments

                                    If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                                    Control0..*
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Obligations
                                      ObligationsActor
                                      SHALL:populate-if-knownAU PS Producer
                                      SHALL:handleAU PS Consumer
                                      SHOULD:displayAU PS Consumer
                                      Summarytrue
                                      Alternate Namesfirst name, middle name
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      30. RelatedPerson.telecom
                                      Definition

                                      A contact detail for the person, e.g. a telephone number or an email address.

                                      ShortA contact detail for the person
                                      Comments

                                      Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

                                      Control0..*
                                      TypeContactPoint
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Obligations
                                        ObligationsActor
                                        SHALL:populate-if-knownAU PS Producer
                                        SHALL:handleAU PS Consumer
                                        SHOULD:displayAU PS Consumer
                                        Summarytrue
                                        Requirements

                                        People have (primary) ways to contact them in some way such as phone, email.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        32. RelatedPerson.address
                                        Definition

                                        Address where the related person can be contacted or visited.

                                        ShortAddress where the related person can be contacted or visited
                                        Comments

                                        The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

                                        Control0..*
                                        TypeAddress(Address, Australian Address)
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Must Support TypesNo must-support rules about the choice of types/profiles
                                        Obligations
                                          ObligationsActor
                                          SHALL:populate-if-knownAU PS Producer
                                          SHALL:handleAU PS Consumer
                                          SHOULD:displayAU PS Consumer
                                          Summarytrue
                                          Requirements

                                          Need to keep track where the related person can be contacted per postal mail or visited.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

                                          Guidance on how to interpret the contents of this table can be foundhere

                                          0. RelatedPerson
                                          Definition

                                          Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

                                          ShortA person related to a patient in an Australian healthcare context
                                          Control0..*
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                                          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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                                          dom-6: A resource should have narrative for robust management (text.`div`.exists())
                                          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 (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: 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: 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: 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: 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')))
                                          au-core-relper-01: Either a name or a relationship shall be provided (or both) (name.exists() or relationship.exists())
                                          au-core-relper-02: 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()))
                                          2. RelatedPerson.id
                                          Definition

                                          The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                                          ShortLogical id of this artifact
                                          Comments

                                          The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                                          Control0..1
                                          Typeid
                                          Is Modifierfalse
                                          Summarytrue
                                          4. RelatedPerson.meta
                                          Definition

                                          The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

                                          ShortMetadata about the resource
                                          Control0..1
                                          TypeMeta
                                          Is Modifierfalse
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          6. RelatedPerson.implicitRules
                                          Definition

                                          A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                                          ShortA set of rules under which this content was created
                                          Comments

                                          Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                                          Control0..1
                                          Typeuri
                                          Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          8. RelatedPerson.language
                                          Definition

                                          The base language in which the resource is written.

                                          ShortLanguage of the resource content
                                          Comments

                                          Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                                          Control0..1
                                          BindingThe codes SHOULD be taken from CommonLanguages
                                          (preferred to http://hl7.org/fhir/ValueSet/languages)

                                          A human language.

                                          Additional BindingsPurpose
                                          AllLanguagesMax Binding
                                          Typecode
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          10. RelatedPerson.text
                                          Definition

                                          A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                                          ShortText summary of the resource, for human interpretation
                                          Comments

                                          Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                                          Control0..1
                                          TypeNarrative
                                          Is Modifierfalse
                                          Summaryfalse
                                          Alternate Namesnarrative, html, xhtml, display
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          12. RelatedPerson.contained
                                          Definition

                                          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                                          ShortContained, inline Resources
                                          Comments

                                          This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                                          Control0..*
                                          TypeResource
                                          Is Modifierfalse
                                          Summaryfalse
                                          Alternate Namesinline resources, anonymous resources, contained resources
                                          14. RelatedPerson.extension
                                          Definition

                                          An Extension

                                          ShortExtension
                                          Control0..*
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          SlicingThis element introduces a set of slices on RelatedPerson.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 16. RelatedPerson.extension:genderIdentity
                                            Slice NamegenderIdentity
                                            Definition

                                            An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else.

                                            ShortGender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
                                            Comments

                                            The individual's gender identity is populated in the extension:value.value[x] of the Individual Gender Identity extension and shall contain one of the codes from the Gender Identity Response value set if any of the codes within the value set can apply.

                                            See Australian Bureau of Statics (ABS) Standard for Sex, Gender, Variations of Sex Characteristics and Sexual Orientation Variables, 2020 for further materials.

                                            Control0..*
                                            This element is affected by the following invariants: inv-relper-0
                                            TypeExtension(Individual Gender Identity) (Complex Extension)
                                            Is Modifierfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            18. RelatedPerson.extension:individualPronouns
                                            Slice NameindividualPronouns
                                            Definition

                                            The pronouns to use when referring to an individual in verbal or written communication.

                                            ShortPronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
                                            Comments

                                            The individual's pronouns are populated in the extension:value.value[x] of the Individual Pronouns extension and shall contain one of the codes from the Australian Pronouns value set if any of the codes within the value set can apply.

                                            Control0..*
                                            This element is affected by the following invariants: inv-relper-1
                                            TypeExtension(Individual Pronouns) (Complex Extension)
                                            Is Modifierfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            20. RelatedPerson.extension:recordedSexOrGender
                                            Slice NamerecordedSexOrGender
                                            Definition

                                            A sex or gender property for the individual from a document or other record

                                            ShortRecorded 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
                                            Comments

                                            The type of recorded sex or gender is populated in the extension:type.value[x] of the Person Recorded Sex or Gender extension and shall contain one of the codes from the AU Recorded Sex or Gender Type value set if any of the codes within the value set can apply.

                                            The document from which the sex or gender property was acquired is populated in the extension:sourceDocument.value[x] of the Person Recorded Sex or Gender extension and shall contain one of the codes from the AU Recorded Sex or Gender (RSG) Source Document Type value set if any of the codes within the value set can apply.

                                            The jurisdiction that issued the document where the sex or gender was acquired is populated in the extension:jurisdiction.value[x] of the Person Recorded Sex or Gender extension and shall contain one of the codes from the Jurisdiction ValueSet - AU Extended value set if any of the codes within the value set can apply.

                                            Control0..*
                                            This element is affected by the following invariants: inv-relper-2, inv-relper-3, inv-relper-4
                                            TypeExtension(Person Recorded Sex Or Gender) (Complex Extension)
                                            Is Modifierfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            22. RelatedPerson.modifierExtension
                                            Definition

                                            May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                            ShortExtensions that cannot be ignored
                                            Comments

                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                            Control0..*
                                            TypeExtension
                                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                            Summaryfalse
                                            Requirements

                                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                            Alternate Namesextensions, user content
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            24. RelatedPerson.identifier
                                            Definition

                                            Identifier for a person within a particular scope.

                                            ShortA human identifier for this person
                                            NoteThis is a business identifier, not a resource identifier (see discussion)
                                            Control0..*
                                            TypeIdentifier(Identifier, AU IHI, AU Medicare Card Number, AU DVA Number, AU Health Care Card Number, AU Pensioner Concession Card Number, AU Commonwealth Seniors Health Card Number, AU Medical Record Number, AU Insurance Member Number)
                                            Is Modifierfalse
                                            Summarytrue
                                            Requirements

                                            People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            26. RelatedPerson.active
                                            Definition

                                            Whether this related person record is in active use.

                                            ShortWhether this related person's record is in active use
                                            Comments

                                            This element is labeled as a modifier because it may be used to mark that the resource was created in error.

                                            Control0..1
                                            Typeboolean
                                            Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            Need to be able to mark a related person record as not to be used, such as if it was created in error.

                                            Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            28. RelatedPerson.patient
                                            Definition

                                            The patient this person is related to.

                                            ShortThe patient this person is related to
                                            Control1..1
                                            TypeReference(AU PS Patient)
                                            Is Modifierfalse
                                            Must Supporttrue
                                            Obligations
                                              ObligationsActor
                                              SHALL:populate-if-knownAU PS Producer
                                              SHALL:handleAU PS Consumer
                                              SHOULD:displayAU PS Consumer
                                              Summarytrue
                                              Requirements

                                              We need to know which patient this RelatedPerson is related to.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              30. RelatedPerson.patient.id
                                              Definition

                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                              ShortUnique id for inter-element referencing
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              32. RelatedPerson.patient.extension
                                              Definition

                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                              ShortAdditional content defined by implementations
                                              Comments

                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                              Control0..*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate Namesextensions, user content
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              SlicingThis element introduces a set of slices on RelatedPerson.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 34. RelatedPerson.patient.reference
                                                Definition

                                                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                ShortLiteral reference, Relative, internal or absolute URL
                                                Comments

                                                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                Control1..1
                                                This element is affected by the following invariants: ref-1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                Obligations
                                                  ObligationsActor
                                                  SHALL:populate-if-knownAU PS Producer
                                                  SHALL:handleAU PS Consumer
                                                  SHOULD:displayAU PS Consumer
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  36. RelatedPerson.patient.type
                                                  Definition

                                                  The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                  The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                  ShortType the reference refers to (e.g. "Patient")
                                                  Comments

                                                  This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                  Control0..1
                                                  BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                  (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                                                  Aa resource (or, for logical models, the URI of the logical model).

                                                  Typeuri
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  38. RelatedPerson.patient.identifier
                                                  Definition

                                                  An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                  ShortLogical reference, when literal reference is not known
                                                  Comments

                                                  When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                  When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                  Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                  Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                                  Control0..1
                                                  TypeIdentifier
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  40. RelatedPerson.patient.display
                                                  Definition

                                                  Plain text narrative that identifies the resource in addition to the resource reference.

                                                  ShortText alternative for the resource
                                                  Comments

                                                  This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  42. RelatedPerson.relationship
                                                  Definition

                                                  The nature of the relationship between a patient and the related person.

                                                  ShortThe nature of the relationship
                                                  Control0..*
                                                  This element is affected by the following invariants: au-core-relper-01
                                                  BindingUnless not suitable, these codes SHALL be taken from Related Person Relationship Type .
                                                  (extensible to https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1)
                                                  TypeCodeableConcept(Codeable Concept (IPS))
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Obligations
                                                    ObligationsActor
                                                    SHALL:populate-if-knownAU PS Producer
                                                    SHALL:handleAU PS Consumer
                                                    SHOULD:displayAU PS Consumer
                                                    Summarytrue
                                                    Requirements

                                                    We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    44. RelatedPerson.name
                                                    Definition

                                                    A name associated with the person.

                                                    ShortA name associated with the person
                                                    Control0..*
                                                    This element is affected by the following invariants: au-core-relper-01
                                                    TypeHumanName
                                                    Is Modifierfalse
                                                    Must Supporttrue
                                                    Obligations
                                                      ObligationsActor
                                                      SHALL:populate-if-knownAU PS Producer
                                                      SHALL:handleAU PS Consumer
                                                      SHOULD:displayAU PS Consumer
                                                      Summarytrue
                                                      Requirements

                                                      Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      46. RelatedPerson.name.id
                                                      Definition

                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                      ShortUnique id for inter-element referencing
                                                      Control0..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      48. RelatedPerson.name.extension
                                                      Definition

                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                      ShortAdditional content defined by implementations
                                                      Comments

                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                      Control0..*
                                                      TypeExtension
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Alternate Namesextensions, user content
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      SlicingThis element introduces a set of slices on RelatedPerson.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 50. RelatedPerson.name.use
                                                        Definition

                                                        Identifies the purpose for this name.

                                                        Shortusual | official | temp | nickname | anonymous | old | maiden
                                                        Comments

                                                        Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                                                        Control0..1
                                                        BindingThe codes SHALL be taken from NameUse
                                                        (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                                                        The use of a human name.

                                                        Typecode
                                                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Must Supporttrue
                                                        Obligations
                                                          ObligationsActor
                                                          SHALL:populate-if-knownAU PS Producer
                                                          SHALL:handleAU PS Consumer
                                                          SHOULD:displayAU PS Consumer
                                                          Summarytrue
                                                          Requirements

                                                          Allows the appropriate name for a particular context of use to be selected from among a set of names.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          52. RelatedPerson.name.text
                                                          Definition

                                                          Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                                                          ShortText representation of the full name
                                                          Comments

                                                          Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                                          Control0..1
                                                          Typestring
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supporttrue
                                                          Obligations
                                                            ObligationsActor
                                                            SHALL:populate-if-knownAU PS Producer
                                                            SHALL:handleAU PS Consumer
                                                            SHOULD:displayAU PS Consumer
                                                            Summarytrue
                                                            Requirements

                                                            A renderable, unencoded form.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            54. RelatedPerson.name.family
                                                            Definition

                                                            The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                                            ShortFamily name (often called 'Surname')
                                                            Comments

                                                            Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                                            Control0..1
                                                            Typestring
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supporttrue
                                                            Obligations
                                                              ObligationsActor
                                                              SHALL:populate-if-knownAU PS Producer
                                                              SHALL:handleAU PS Consumer
                                                              SHOULD:displayAU PS Consumer
                                                              Summarytrue
                                                              Alternate Namessurname
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              56. RelatedPerson.name.given
                                                              Definition

                                                              Given name.

                                                              ShortGiven names (not always 'first'). Includes middle names
                                                              Comments

                                                              If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                                                              Control0..*
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Obligations
                                                                ObligationsActor
                                                                SHALL:populate-if-knownAU PS Producer
                                                                SHALL:handleAU PS Consumer
                                                                SHOULD:displayAU PS Consumer
                                                                Summarytrue
                                                                Alternate Namesfirst name, middle name
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                58. RelatedPerson.name.prefix
                                                                Definition

                                                                Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                                ShortParts that come before the name
                                                                Control0..*
                                                                Typestring
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                60. RelatedPerson.name.suffix
                                                                Definition

                                                                Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                                                ShortParts that come after the name
                                                                Control0..*
                                                                Typestring
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                62. RelatedPerson.name.period
                                                                Definition

                                                                Indicates the period of time when this name was valid for the named person.

                                                                ShortTime period when name was/is in use
                                                                Control0..1
                                                                TypePeriod
                                                                Is Modifierfalse
                                                                Summarytrue
                                                                Requirements

                                                                Allows names to be placed in historical context.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                64. RelatedPerson.telecom
                                                                Definition

                                                                A contact detail for the person, e.g. a telephone number or an email address.

                                                                ShortA contact detail for the person
                                                                Comments

                                                                Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

                                                                Control0..*
                                                                TypeContactPoint
                                                                Is Modifierfalse
                                                                Must Supporttrue
                                                                Obligations
                                                                  ObligationsActor
                                                                  SHALL:populate-if-knownAU PS Producer
                                                                  SHALL:handleAU PS Consumer
                                                                  SHOULD:displayAU PS Consumer
                                                                  Summarytrue
                                                                  Requirements

                                                                  People have (primary) ways to contact them in some way such as phone, email.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  66. RelatedPerson.gender
                                                                  Definition

                                                                  Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

                                                                  Shortmale | female | other | unknown
                                                                  Control0..1
                                                                  BindingThe codes SHALL be taken from AdministrativeGender
                                                                  (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                                                                  The gender of a person used for administrative purposes.

                                                                  Typecode
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Requirements

                                                                  Needed for identification of the person, in combination with (at least) name and birth date.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  68. RelatedPerson.birthDate
                                                                  Definition

                                                                  The date on which the related person was born.

                                                                  ShortThe date on which the related person was born
                                                                  Control0..1
                                                                  Typedate
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  70. RelatedPerson.address
                                                                  Definition

                                                                  Address where the related person can be contacted or visited.

                                                                  ShortAddress where the related person can be contacted or visited
                                                                  Comments

                                                                  The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

                                                                  Control0..*
                                                                  TypeAddress(Address, Australian Address)
                                                                  Is Modifierfalse
                                                                  Must Supporttrue
                                                                  Must Support TypesNo must-support rules about the choice of types/profiles
                                                                  Obligations
                                                                    ObligationsActor
                                                                    SHALL:populate-if-knownAU PS Producer
                                                                    SHALL:handleAU PS Consumer
                                                                    SHOULD:displayAU PS Consumer
                                                                    Summarytrue
                                                                    Requirements

                                                                    Need to keep track where the related person can be contacted per postal mail or visited.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    72. RelatedPerson.photo
                                                                    Definition

                                                                    Image of the person.

                                                                    ShortImage of the person
                                                                    Control0..*
                                                                    TypeAttachment
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    74. RelatedPerson.period
                                                                    Definition

                                                                    The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.

                                                                    ShortPeriod of time that this relationship is considered valid
                                                                    Control0..1
                                                                    TypePeriod
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    76. RelatedPerson.communication
                                                                    Definition

                                                                    A language which may be used to communicate with about the patient's health.

                                                                    ShortA language which may be used to communicate with about the patient's health
                                                                    Comments

                                                                    If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                                                    Control0..*
                                                                    TypeBackboneElement
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    78. RelatedPerson.communication.id
                                                                    Definition

                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                    ShortUnique id for inter-element referencing
                                                                    Control0..1
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    80. RelatedPerson.communication.extension
                                                                    Definition

                                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                    ShortAdditional content defined by implementations
                                                                    Comments

                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                    Control0..*
                                                                    TypeExtension
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Alternate Namesextensions, user content
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    82. RelatedPerson.communication.modifierExtension
                                                                    Definition

                                                                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                    Comments

                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                    Control0..*
                                                                    TypeExtension
                                                                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                    Summarytrue
                                                                    Requirements

                                                                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                    Alternate Namesextensions, user content, modifiers
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    84. RelatedPerson.communication.language
                                                                    Definition

                                                                    A language which can be used to communicate with about the patient's health. The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

                                                                    ShortThe language which can be used to communicate with the patient about his or her health
                                                                    Comments

                                                                    The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

                                                                    Control1..1
                                                                    BindingUnless not suitable, these codes SHALL be taken from Common Languages in Australia .
                                                                    (extensible to https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2)
                                                                    TypeCodeableConcept
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    86. RelatedPerson.communication.preferred
                                                                    Definition

                                                                    Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

                                                                    ShortLanguage preference indicator
                                                                    Comments

                                                                    This language is specifically identified for communicating healthcare information.

                                                                    Control0..1
                                                                    Typeboolean
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summaryfalse
                                                                    Requirements

                                                                    People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))