AU Patient Summary Implementation Guide
1.0.1-ci-build - 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 1.0.1-ci-build 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: AU PS RelatedPerson

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson Version: 1.0.1-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AUPSRelatedPerson

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a RelatedPerson resource in the context of a patient summary in an Australian context. It is based on the AU Core Related Person profile, and applies the additional constraints for use in a patient summary context consistent with the profiling conventions of IPS.

See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.

Profile Specific Implementation Guidance

Examples for this Profile: Bundle/aups-section-emptyreason

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson C 0..* AUCoreRelatedPerson A person related to a patient in an Australian healthcare context
Constraints: inv-relper-0, inv-relper-1, inv-relper-2, inv-relper-3, inv-relper-4, inv-relper-5, au-core-relper-01, au-core-relper-02
RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
RelatedPerson.Slices for extension Content/Rules for all slices
RelatedPerson.Slices for extension.extension:genderIdentity C 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
RelatedPerson.Slices for extension.extension:individualPronouns C 0..* (Complex) Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
RelatedPerson.Slices for extension.extension:recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) The patient this person is related to
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.patient.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.relationship This element has obligations and must be supported. This element is included in summaries. C 0..* CodeableConceptIPS The nature of the relationship
Binding: Related Person Relationship Type (extensible)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name This element has obligations and must be supported. This element is included in summaries. C 0..* HumanName A name associated with the person
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name.use This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.name.text This element has obligations and must be supported. This element is included in summaries. 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name.family This element has obligations and must be supported. This element is included in summaries. 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.name.given This element has obligations and must be supported. This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.telecom This element has obligations and must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.address This element has obligations and must be supported. This element is included in summaries. 0..* Address The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address where the related person can be contacted or visited
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base extensible Related Person Relationship Type ⏿1.2.2 tx.hl7.org.au
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
au-core-relper-01 error RelatedPerson Either a name or a relationship shall be provided (or both) name.exists() or relationship.exists()
au-core-relper-02 error RelatedPerson Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists())
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-relper-0 warning RelatedPerson Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-relper-1 warning RelatedPerson Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-relper-2 warning RelatedPerson Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-relper-3 warning RelatedPerson Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-relper-4 warning RelatedPerson Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-relper-5 warning RelatedPerson Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

This structure is derived from AUCoreRelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson 0..* AUCoreRelatedPerson A person related to a patient in an Australian healthcare context
RelatedPerson.patient This element has obligations. 1..1 Reference(AU PS Patient) The patient this person is related to
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.patient.reference This element has obligations and must be supported. 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.relationship This element has obligations. 0..* CodeableConceptIPS The nature of the relationship
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name This element has obligations. 0..* HumanName A name associated with the person
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name.use This element has obligations. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.name.text This element has obligations. 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name.family This element has obligations. 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.name.given This element has obligations. 0..* string Given names (not always 'first'). Includes middle names
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.address This element has obligations. 0..* Address, AustralianAddress Address where the related person can be contacted or visited
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson C 0..* AUCoreRelatedPerson A person related to a patient in an Australian healthcare context
Constraints: inv-relper-0, inv-relper-1, inv-relper-2, inv-relper-3, inv-relper-4, inv-relper-5, au-core-relper-01, au-core-relper-02
RelatedPerson.id This element is included in summaries. 0..1 id Logical id of this artifact
RelatedPerson.meta This element is included in summaries. 0..1 Meta Metadata about the resource
RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
RelatedPerson.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
RelatedPerson.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
RelatedPerson.contained 0..* Resource Contained, inline Resources
RelatedPerson.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
RelatedPerson.Slices for extension.extension:genderIdentity C 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
RelatedPerson.Slices for extension.extension:individualPronouns C 0..* (Complex) Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
RelatedPerson.Slices for extension.extension:recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.identifier This element is included in summaries. 0..* Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUIHI The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUMedicareCardNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUDVANumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHealthCareCardNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUPensionerConcessionCardNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUCwlthSeniorsHealthCardNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUMedicalRecordNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUInsuranceMemberNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A human identifier for this person
RelatedPerson.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) The patient this person is related to
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.patient.id 0..1 string Unique id for inter-element referencing
RelatedPerson.patient.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.patient.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.patient.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
RelatedPerson.patient.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
RelatedPerson.patient.display This element is included in summaries. 0..1 string Text alternative for the resource
RelatedPerson.relationship This element has obligations and must be supported. This element is included in summaries. C 0..* CodeableConceptIPS The nature of the relationship
Binding: Related Person Relationship Type (extensible)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name This element has obligations and must be supported. This element is included in summaries. C 0..* HumanName A name associated with the person
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name.id 0..1 string Unique id for inter-element referencing
RelatedPerson.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.name.use This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.name.text This element has obligations and must be supported. This element is included in summaries. 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name.family This element has obligations and must be supported. This element is included in summaries. 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.name.given This element has obligations and must be supported. This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
RelatedPerson.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
RelatedPerson.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
RelatedPerson.telecom This element has obligations and must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
RelatedPerson.birthDate This element is included in summaries. 0..1 date The date on which the related person was born
RelatedPerson.address This element has obligations and must be supported. This element is included in summaries. 0..* Address The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address where the related person can be contacted or visited
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.photo 0..* Attachment Image of the person
RelatedPerson.period 0..1 Period Period of time that this relationship is considered valid
RelatedPerson.communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
RelatedPerson.communication.id 0..1 string Unique id for inter-element referencing
RelatedPerson.communication.extension 0..* Extension Additional content defined by implementations
RelatedPerson.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
RelatedPerson.communication.language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Common Languages in Australia (extensible)
RelatedPerson.communication.preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
RelatedPerson.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base extensible Related Person Relationship Type ⏿1.2.2 tx.hl7.org.au
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base extensible Common Languages in Australia ⏿2.2.1 tx.hl7.org.au

Constraints

Id Grade Path(s) Description Expression
au-core-relper-01 error RelatedPerson Either a name or a relationship shall be provided (or both) name.exists() or relationship.exists()
au-core-relper-02 error RelatedPerson Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists())
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-relper-0 warning RelatedPerson Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-relper-1 warning RelatedPerson Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-relper-2 warning RelatedPerson Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-relper-3 warning RelatedPerson Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-relper-4 warning RelatedPerson Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-relper-5 warning RelatedPerson Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

This structure is derived from AUCoreRelatedPerson

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson C 0..* AUCoreRelatedPerson A person related to a patient in an Australian healthcare context
Constraints: inv-relper-0, inv-relper-1, inv-relper-2, inv-relper-3, inv-relper-4, inv-relper-5, au-core-relper-01, au-core-relper-02
RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
RelatedPerson.Slices for extension Content/Rules for all slices
RelatedPerson.Slices for extension.extension:genderIdentity C 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
RelatedPerson.Slices for extension.extension:individualPronouns C 0..* (Complex) Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
RelatedPerson.Slices for extension.extension:recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) The patient this person is related to
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.patient.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.relationship This element has obligations and must be supported. This element is included in summaries. C 0..* CodeableConceptIPS The nature of the relationship
Binding: Related Person Relationship Type (extensible)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name This element has obligations and must be supported. This element is included in summaries. C 0..* HumanName A name associated with the person
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name.use This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.name.text This element has obligations and must be supported. This element is included in summaries. 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name.family This element has obligations and must be supported. This element is included in summaries. 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.name.given This element has obligations and must be supported. This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.telecom This element has obligations and must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.address This element has obligations and must be supported. This element is included in summaries. 0..* Address The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address where the related person can be contacted or visited
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base extensible Related Person Relationship Type ⏿1.2.2 tx.hl7.org.au
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
au-core-relper-01 error RelatedPerson Either a name or a relationship shall be provided (or both) name.exists() or relationship.exists()
au-core-relper-02 error RelatedPerson Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists())
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-relper-0 warning RelatedPerson Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-relper-1 warning RelatedPerson Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-relper-2 warning RelatedPerson Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-relper-3 warning RelatedPerson Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-relper-4 warning RelatedPerson Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-relper-5 warning RelatedPerson Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

Differential View

This structure is derived from AUCoreRelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson 0..* AUCoreRelatedPerson A person related to a patient in an Australian healthcare context
RelatedPerson.patient This element has obligations. 1..1 Reference(AU PS Patient) The patient this person is related to
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.patient.reference This element has obligations and must be supported. 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.relationship This element has obligations. 0..* CodeableConceptIPS The nature of the relationship
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name This element has obligations. 0..* HumanName A name associated with the person
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name.use This element has obligations. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.name.text This element has obligations. 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name.family This element has obligations. 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.name.given This element has obligations. 0..* string Given names (not always 'first'). Includes middle names
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.telecom This element has obligations. 0..* ContactPoint A contact detail for the person
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.address This element has obligations. 0..* Address, AustralianAddress Address where the related person can be contacted or visited
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson C 0..* AUCoreRelatedPerson A person related to a patient in an Australian healthcare context
Constraints: inv-relper-0, inv-relper-1, inv-relper-2, inv-relper-3, inv-relper-4, inv-relper-5, au-core-relper-01, au-core-relper-02
RelatedPerson.id This element is included in summaries. 0..1 id Logical id of this artifact
RelatedPerson.meta This element is included in summaries. 0..1 Meta Metadata about the resource
RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
RelatedPerson.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
RelatedPerson.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
RelatedPerson.contained 0..* Resource Contained, inline Resources
RelatedPerson.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
RelatedPerson.Slices for extension.extension:genderIdentity C 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
RelatedPerson.Slices for extension.extension:individualPronouns C 0..* (Complex) Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
RelatedPerson.Slices for extension.extension:recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.identifier This element is included in summaries. 0..* Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUIHI The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUMedicareCardNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUDVANumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHealthCareCardNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUPensionerConcessionCardNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUCwlthSeniorsHealthCardNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUMedicalRecordNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUInsuranceMemberNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well A human identifier for this person
RelatedPerson.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) The patient this person is related to
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.patient.id 0..1 string Unique id for inter-element referencing
RelatedPerson.patient.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.patient.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.patient.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
RelatedPerson.patient.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
RelatedPerson.patient.display This element is included in summaries. 0..1 string Text alternative for the resource
RelatedPerson.relationship This element has obligations and must be supported. This element is included in summaries. C 0..* CodeableConceptIPS The nature of the relationship
Binding: Related Person Relationship Type (extensible)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name This element has obligations and must be supported. This element is included in summaries. C 0..* HumanName A name associated with the person
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name.id 0..1 string Unique id for inter-element referencing
RelatedPerson.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.name.use This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.name.text This element has obligations and must be supported. This element is included in summaries. 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.name.family This element has obligations and must be supported. This element is included in summaries. 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.name.given This element has obligations and must be supported. This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
RelatedPerson.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
RelatedPerson.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
RelatedPerson.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
RelatedPerson.telecom This element has obligations and must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
RelatedPerson.birthDate This element is included in summaries. 0..1 date The date on which the related person was born
RelatedPerson.address This element has obligations and must be supported. This element is included in summaries. 0..* Address The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address where the related person can be contacted or visited
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
RelatedPerson.photo 0..* Attachment Image of the person
RelatedPerson.period 0..1 Period Period of time that this relationship is considered valid
RelatedPerson.communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
RelatedPerson.communication.id 0..1 string Unique id for inter-element referencing
RelatedPerson.communication.extension 0..* Extension Additional content defined by implementations
RelatedPerson.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
RelatedPerson.communication.language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Common Languages in Australia (extensible)
RelatedPerson.communication.preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
RelatedPerson.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base extensible Related Person Relationship Type ⏿1.2.2 tx.hl7.org.au
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base extensible Common Languages in Australia ⏿2.2.1 tx.hl7.org.au

Constraints

Id Grade Path(s) Description Expression
au-core-relper-01 error RelatedPerson Either a name or a relationship shall be provided (or both) name.exists() or relationship.exists()
au-core-relper-02 error RelatedPerson Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists())
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-relper-0 warning RelatedPerson Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-relper-1 warning RelatedPerson Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-relper-2 warning RelatedPerson Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-relper-3 warning RelatedPerson Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-relper-4 warning RelatedPerson Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-relper-5 warning RelatedPerson Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

This structure is derived from AUCoreRelatedPerson

 

Other representations of profile: CSV, Excel, Schematron