AU Core Implementation Guide
1.1.0-ci-build - CI Build
AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.1.0-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-core/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson | Version: 1.1.0-ci-build | |||
Standards status: Trial-use | Maturity Level: 0 | Computable Name: AUCoreRelatedPerson | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
This profile sets minimum expectations for a RelatedPerson resource to record, search, and fetch basic demographics and other administrative information about individual related persons associated with a patient. It is based on the AU Base Related Person profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the RelatedPerson resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.
The following are supported usage scenarios for this profile:
name.text
and/or parts such as name.family
and name.given
.
name.text
specifies the entire name as it is intended to be displayed. This may be provided instead of, or as well as, the specific parts. It is important to note that the presence of parts of a name, e.g. name.family
and name.given
, do not imply that name.text
is known or needs to be supplied.name
are marked as Must Support: name.use
, name.text
, name.family
, and name.given
name.text
, name.family
, and name.given
name.use
, name.text
, name.family
, and name.given
Usage:
Changes since version 1.0.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseRelatedPerson
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBaseRelatedPerson | A person related to a patient in an Australian healthcare context au-core-relper-01: Either a name or a relationship shall be provided (or both) 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 | ||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core Patient) | The patient this person is related to
| ||||||
![]() ![]() ![]() |
SOC | 0..* | CodeableConcept | The nature of the relationship
| ||||||
![]() ![]() ![]() |
SOC | 0..* | HumanName | A name associated with the person
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | string | Text representation of the full name
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | string | Family name (often called 'Surname')
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..* | string | Given names (not always 'first'). Includes middle names
| ||||||
![]() ![]() ![]() |
SO | 0..* | ContactPoint | A contact detail for the person
| ||||||
![]() ![]() ![]() |
SO | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited
| ||||||
![]() |
Id | Grade | Path(s) | Details | Requirements |
au-core-relper-01 | error | RelatedPerson | Either a name or a relationship shall be provided (or both) : name.exists() or relationship.exists() | |
au-core-relper-02 | error | RelatedPerson | Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present : name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists()) |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBaseRelatedPerson | A person related to a patient in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 inv-relper-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply 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 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 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 au-core-relper-01: Either a name or a relationship shall be provided (or both) 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 | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() ![]() ![]() |
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | The patient this person is related to ele-1: All FHIR elements must have a @value or children
| ||||||
![]() ![]() ![]() |
SOΣC | 0..* | CodeableConcept | The nature of the relationship Binding: Related Person Relationship Type ![]() ele-1: All FHIR elements must have a @value or children
| ||||||
![]() ![]() ![]() |
SOΣC | 0..* | HumanName | A name associated with the person ele-1: All FHIR elements must have a @value or children
| ||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name ele-1: All FHIR elements must have a @value or children
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
![]() ![]() ![]() |
SOΣ | 0..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children
| ||||||
![]() ![]() ![]() |
SOΣ | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited ele-1: All FHIR elements must have a @value or children
| ||||||
![]() |
Path | Conformance | ValueSet | URI |
RelatedPerson.relationship | extensible | RelatedPersonRelationshipType ![]() https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | |
RelatedPerson.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
au-core-relper-01 | error | RelatedPerson | Either a name or a relationship shall be provided (or both) : name.exists() or relationship.exists() | |
au-core-relper-02 | error | RelatedPerson | Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present : name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists()) | |
dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-relper-0 | warning | RelatedPerson | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-relper-1 | warning | RelatedPerson | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) | |
inv-relper-2 | warning | RelatedPerson | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) | |
inv-relper-3 | warning | RelatedPerson | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) | |
inv-relper-4 | warning | RelatedPerson | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBaseRelatedPerson | A person related to a patient in an Australian healthcare context 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 inv-relper-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply 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 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 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 au-core-relper-01: Either a name or a relationship shall be provided (or both) 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 | ||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity | ||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns | ||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | The patient this person is related to
| ||||||
![]() ![]() ![]() |
SOΣC | 0..* | CodeableConcept | The nature of the relationship Binding: Related Person Relationship Type ![]()
| ||||||
![]() ![]() ![]() |
SOΣC | 0..* | HumanName | A name associated with the person
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||||
![]() ![]() ![]() |
SOΣ | 0..* | ContactPoint | A contact detail for the person
| ||||||
![]() ![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||||
![]() ![]() ![]() |
Σ | 0..1 | date | The date on which the related person was born | ||||||
![]() ![]() ![]() |
SOΣ | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited
| ||||||
![]() ![]() ![]() |
0..* | Attachment | Image of the person | |||||||
![]() ![]() ![]() |
0..1 | Period | Period of time that this relationship is considered valid | |||||||
![]() ![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia ![]() | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||||
![]() |
Path | Conformance | ValueSet | URI | |||
RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
RelatedPerson.relationship | extensible | RelatedPersonRelationshipType ![]() https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | ||||
RelatedPerson.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
RelatedPerson.communication.language | extensible | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
Id | Grade | Path(s) | Details | Requirements |
au-core-relper-01 | error | RelatedPerson | Either a name or a relationship shall be provided (or both) : name.exists() or relationship.exists() | |
au-core-relper-02 | error | RelatedPerson | Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present : name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists()) | |
dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-relper-0 | warning | RelatedPerson | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-relper-1 | warning | RelatedPerson | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) | |
inv-relper-2 | warning | RelatedPerson | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) | |
inv-relper-3 | warning | RelatedPerson | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) | |
inv-relper-4 | warning | RelatedPerson | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
This structure is derived from AUBaseRelatedPerson
Summary
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from AUBaseRelatedPerson
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBaseRelatedPerson | A person related to a patient in an Australian healthcare context au-core-relper-01: Either a name or a relationship shall be provided (or both) 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 | ||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core Patient) | The patient this person is related to
| ||||||
![]() ![]() ![]() |
SOC | 0..* | CodeableConcept | The nature of the relationship
| ||||||
![]() ![]() ![]() |
SOC | 0..* | HumanName | A name associated with the person
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | string | Text representation of the full name
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | string | Family name (often called 'Surname')
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..* | string | Given names (not always 'first'). Includes middle names
| ||||||
![]() ![]() ![]() |
SO | 0..* | ContactPoint | A contact detail for the person
| ||||||
![]() ![]() ![]() |
SO | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited
| ||||||
![]() |
Id | Grade | Path(s) | Details | Requirements |
au-core-relper-01 | error | RelatedPerson | Either a name or a relationship shall be provided (or both) : name.exists() or relationship.exists() | |
au-core-relper-02 | error | RelatedPerson | Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present : name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists()) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBaseRelatedPerson | A person related to a patient in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 inv-relper-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply 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 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 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 au-core-relper-01: Either a name or a relationship shall be provided (or both) 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 | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() ![]() ![]() |
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use ele-1: All FHIR elements must have a @value or children | ||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | The patient this person is related to ele-1: All FHIR elements must have a @value or children
| ||||||
![]() ![]() ![]() |
SOΣC | 0..* | CodeableConcept | The nature of the relationship Binding: Related Person Relationship Type ![]() ele-1: All FHIR elements must have a @value or children
| ||||||
![]() ![]() ![]() |
SOΣC | 0..* | HumanName | A name associated with the person ele-1: All FHIR elements must have a @value or children
| ||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name ele-1: All FHIR elements must have a @value or children
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
![]() ![]() ![]() |
SOΣ | 0..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children
| ||||||
![]() ![]() ![]() |
SOΣ | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited ele-1: All FHIR elements must have a @value or children
| ||||||
![]() |
Path | Conformance | ValueSet | URI |
RelatedPerson.relationship | extensible | RelatedPersonRelationshipType ![]() https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | |
RelatedPerson.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
au-core-relper-01 | error | RelatedPerson | Either a name or a relationship shall be provided (or both) : name.exists() or relationship.exists() | |
au-core-relper-02 | error | RelatedPerson | Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present : name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists()) | |
dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-relper-0 | warning | RelatedPerson | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-relper-1 | warning | RelatedPerson | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) | |
inv-relper-2 | warning | RelatedPerson | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) | |
inv-relper-3 | warning | RelatedPerson | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) | |
inv-relper-4 | warning | RelatedPerson | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBaseRelatedPerson | A person related to a patient in an Australian healthcare context 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 inv-relper-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply 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 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 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 au-core-relper-01: Either a name or a relationship shall be provided (or both) 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 | ||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity | ||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns | ||||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | The patient this person is related to
| ||||||
![]() ![]() ![]() |
SOΣC | 0..* | CodeableConcept | The nature of the relationship Binding: Related Person Relationship Type ![]()
| ||||||
![]() ![]() ![]() |
SOΣC | 0..* | HumanName | A name associated with the person
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||||
![]() ![]() ![]() |
SOΣ | 0..* | ContactPoint | A contact detail for the person
| ||||||
![]() ![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||||
![]() ![]() ![]() |
Σ | 0..1 | date | The date on which the related person was born | ||||||
![]() ![]() ![]() |
SOΣ | 0..* | Address, AustralianAddress | Address where the related person can be contacted or visited
| ||||||
![]() ![]() ![]() |
0..* | Attachment | Image of the person | |||||||
![]() ![]() ![]() |
0..1 | Period | Period of time that this relationship is considered valid | |||||||
![]() ![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages in Australia ![]() | |||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||||
![]() |
Path | Conformance | ValueSet | URI | |||
RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
RelatedPerson.relationship | extensible | RelatedPersonRelationshipType ![]() https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1 | ||||
RelatedPerson.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
RelatedPerson.communication.language | extensible | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
Id | Grade | Path(s) | Details | Requirements |
au-core-relper-01 | error | RelatedPerson | Either a name or a relationship shall be provided (or both) : name.exists() or relationship.exists() | |
au-core-relper-02 | error | RelatedPerson | Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present : name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists()) | |
dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-relper-0 | warning | RelatedPerson | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) | |
inv-relper-1 | warning | RelatedPerson | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) | |
inv-relper-2 | warning | RelatedPerson | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) | |
inv-relper-3 | warning | RelatedPerson | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type')) | |
inv-relper-4 | warning | RelatedPerson | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) |
This structure is derived from AUBaseRelatedPerson
Summary
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.
FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.
Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
---|---|---|---|
patient | SHALL | reference |
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
_id | SHOULD | token |
|
patient+relationship | SHOULD | reference +token |
|
patient+name | SHOULD | reference +string |
|
name | MAY | string |
|
relationship | MAY | token |
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
The following search parameters and search parameter combinations SHALL be supported:
patient
search parameter:
patient.identifier
(e.g. patient.identifier=[system|][code]
)GET [base]/RelatedPerson?patient={Type/}[id]
or optionally GET [base]/RelatedPerson?patient.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle of all RelatedPerson resources for the specified patient (how to search by reference and how to search by token)
The following search parameters and search parameter combinations SHOULD be supported:
SHOULD support searching using the _id
search parameter:
GET [base]/RelatedPerson?_id=[id]
Example:
Implementation Notes: Fetches a bundle with the requested RelatedPerson, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)
patient
and relationship
search parameters:
patient.identifier
(e.g. patient.identifier=[system|][code]
)GET [base]/RelatedPerson?patient={Type/}[id]&relationship={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all RelatedPerson resources for the specified patient and relationship code (how to search by reference and how to search by token)
patient
and name
search parameters:
patient.identifier
(e.g. patient.identifier=[system|][code]
)GET [base]/RelatedPerson?patient={Type/}[id]&name=[string]
Example:
Implementation Notes: Fetches a bundle of all RelatedPerson resources for the specified patient and name (how to search by reference and how to search by string)