MediRecords FHIR Implementation Guide
1.4.1 - release
| Defining URL: | https://fhir.medirecords.com/StructureDefinition/mr-related-person-core |
| Version: | 1.4.1 |
| Name: | MRRelatedPerson |
| Title: | MR RelatedPerson |
| Status: | Active as of 2025-02-03 04:29:41+0000 |
| Definition: | MediRecords RelatedPerson profile to represent Patient's relationship with other individual |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://fhir.medirecords.com/StructureDefinition/mr-related-person-core
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseRelatedPerson
Summary
Mandatory: 2 elements(18 nested mandatory elements)
Must-Support: 23 elements
Fixed: 12 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from AUBaseRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedPerson |
AUBaseRelatedPerson | |||
  meta |
||||
  lastUpdated |
S | 0..1 | instant | When the resource version last changed |
 profile |
1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
 patient |
S | 1..1 | Reference(MR Patient) | The patient this person is related to |
| relationship |
S | 1..* | CodeableConcept | The nature of the relationship |
| name |
1..* | HumanName | A name associated with the person | |
| text |
S | 0..1 | string | Text representation of the full name Max Length:100 |
  Slices for telecom |
0..* | ContactPoint | A contact detail for the person Slice: Unordered, Open by value:use, value:system | |
   telecom:email |
SC | 0..1 | ContactPoint | Email inv-mr-rp-telecom-email-value-01: Please Provide a valid email id |
  system |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
| value |
S | 1..1 | string | The actual contact point details Max Length:100 |
 use |
S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
| telecom:homePhone |
SC | 0..1 | ContactPoint | Home Phone. The number should be of 10 digits length inv-mr-rp-telecom-home-value-01: Home Phone must be of 10 digits |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value |
S | 1..1 | string | The actual contact point details |
| use |
S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
| telecom:workPhone |
SC | 0..1 | ContactPoint | Work Phone. The number should be of 10 digits length inv-mr-rp-telecom-work-value-01: Work Phone must be of 10 digits |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value |
S | 1..1 | string | The actual contact point details |
| use |
S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work |
| telecom:mobile |
SC | 0..1 | ContactPoint | Mobile. The number should be of 10 digits length inv-mr-rp-telecom-mobile-value-01: Mobile Phone must be of 10 digits |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value |
S | 1..1 | string | The actual contact point details |
| use |
S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile |
| telecom:sms |
SC | 0..1 | ContactPoint | SMS. The number should be of 10 digits length inv-mr-rp-telecom-mobile-value-01: Mobile Phone must be of 10 digits |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: sms | |
| value |
S | 1..1 | string | The actual contact point details |
| use |
S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile |
 telecom:letter |
S | 0..1 | ContactPoint | Letter |
| system |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: other |
| value |
0..0 | |||
| use |
S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | AUBaseRelatedPerson | A person related to a patient in an Australian healthcare context | |||||
 id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
SΣ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person | |||||
| active |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||
| patient |
SΣ | 1..1 | Reference(MR Patient) | The patient this person is related to | ||||
| relationship |
SΣ | 1..* | CodeableConcept | The nature of the relationship Binding: Related Person Relationship Type  (extensible) | ||||
| name |
Σ | 1..* | HumanName | A name associated with the person | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text |
SΣ | 0..1 | string | Text representation of the full name Max Length:100 | ||||
| family |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given |
Σ | 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 | ||||
| prefix |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
| Slices for telecom |
Σ | 0..* | ContactPoint | A contact detail for the person Slice: Unordered, Open by value:use, value:system | ||||
| telecom:email |
SΣC | 0..1 | ContactPoint | Email inv-mr-rp-telecom-email-value-01: Please Provide a valid email id | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
| value |
SΣ | 1..1 | string | The actual contact point details Max Length:100 | ||||
| use |
?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:homePhone |
SΣC | 0..1 | ContactPoint | Home Phone. The number should be of 10 digits length inv-mr-rp-telecom-home-value-01: Home Phone must be of 10 digits | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value |
SΣ | 1..1 | string | The actual contact point details | ||||
| use |
?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:workPhone |
SΣC | 0..1 | ContactPoint | Work Phone. The number should be of 10 digits length inv-mr-rp-telecom-work-value-01: Work Phone must be of 10 digits | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value |
SΣ | 1..1 | string | The actual contact point details | ||||
| use |
?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:mobile |
SΣC | 0..1 | ContactPoint | Mobile. The number should be of 10 digits length inv-mr-rp-telecom-mobile-value-01: Mobile Phone must be of 10 digits | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value |
SΣ | 1..1 | string | The actual contact point details | ||||
| use |
?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:sms |
SΣC | 0..1 | ContactPoint | SMS. The number should be of 10 digits length inv-mr-rp-telecom-mobile-value-01: Mobile Phone must be of 10 digits | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: sms | ||||
| value |
SΣ | 1..1 | string | The actual contact point details | ||||
| use |
?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:letter |
SΣ | 0..1 | ContactPoint | Letter | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: other | ||||
| use |
?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date on which the related person was born | ||||
| address |
0..* | Address, AustralianAddress | Address where the related person can be contacted or visited | |||||
| photo |
0..* | Attachment | Image of the person | |||||
| period |
0..1 | Period | Period of time that this relationship is considered valid | |||||
| communication |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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) | |||||
| preferred |
0..1 | boolean | Language preference indicator | |||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson |
0..* | AUBaseRelatedPerson | A person related to a patient in an Australian healthcare context | |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed |
| patient |
Σ | 1..1 | Reference(MR Patient) | The patient this person is related to |
| relationship |
Σ | 1..* | CodeableConcept | The nature of the relationship Binding: Related Person Relationship Type (extensible) |
| name |
Σ | 1..* | HumanName | A name associated with the person |
| text |
Σ | 0..1 | string | Text representation of the full name Max Length:100 |
| Slices for telecom |
Content/Rules for all slices | |||
| telecom:email |
ΣC | 0..1 | ContactPoint | Email inv-mr-rp-telecom-email-value-01: Please Provide a valid email id |
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
| value |
Σ | 1..1 | string | The actual contact point details Max Length:100 |
| use |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home |
| telecom:homePhone |
ΣC | 0..1 | ContactPoint | Home Phone. The number should be of 10 digits length inv-mr-rp-telecom-home-value-01: Home Phone must be of 10 digits |
| value |
Σ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home |
| telecom:workPhone |
ΣC | 0..1 | ContactPoint | Work Phone. The number should be of 10 digits length inv-mr-rp-telecom-work-value-01: Work Phone must be of 10 digits |
| value |
Σ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work |
| telecom:mobile |
ΣC | 0..1 | ContactPoint | Mobile. The number should be of 10 digits length inv-mr-rp-telecom-mobile-value-01: Mobile Phone must be of 10 digits |
| value |
Σ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile |
| telecom:sms |
ΣC | 0..1 | ContactPoint | SMS. The number should be of 10 digits length inv-mr-rp-telecom-mobile-value-01: Mobile Phone must be of 10 digits |
| value |
Σ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile |
| telecom:letter |
Σ | 0..1 | ContactPoint | Letter |
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: other |
| use |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home |
| Documentation for this format | ||||
This structure is derived from AUBaseRelatedPerson
Summary
Mandatory: 2 elements(18 nested mandatory elements)
Must-Support: 23 elements
Fixed: 12 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AUBaseRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson |
AUBaseRelatedPerson | |||
| meta |
||||
| lastUpdated |
S | 0..1 | instant | When the resource version last changed |
| profile |
1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| patient |
S | 1..1 | Reference(MR Patient) | The patient this person is related to |
| relationship |
S | 1..* | CodeableConcept | The nature of the relationship |
| name |
1..* | HumanName | A name associated with the person | |
| text |
S | 0..1 | string | Text representation of the full name Max Length:100 |
| Slices for telecom |
0..* | ContactPoint | A contact detail for the person Slice: Unordered, Open by value:use, value:system | |
| telecom:email |
SC | 0..1 | ContactPoint | Email inv-mr-rp-telecom-email-value-01: Please Provide a valid email id |
| system |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
| value |
S | 1..1 | string | The actual contact point details Max Length:100 |
| use |
S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
| telecom:homePhone |
SC | 0..1 | ContactPoint | Home Phone. The number should be of 10 digits length inv-mr-rp-telecom-home-value-01: Home Phone must be of 10 digits |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value |
S | 1..1 | string | The actual contact point details |
| use |
S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
| telecom:workPhone |
SC | 0..1 | ContactPoint | Work Phone. The number should be of 10 digits length inv-mr-rp-telecom-work-value-01: Work Phone must be of 10 digits |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value |
S | 1..1 | string | The actual contact point details |
| use |
S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work |
| telecom:mobile |
SC | 0..1 | ContactPoint | Mobile. The number should be of 10 digits length inv-mr-rp-telecom-mobile-value-01: Mobile Phone must be of 10 digits |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value |
S | 1..1 | string | The actual contact point details |
| use |
S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile |
| telecom:sms |
SC | 0..1 | ContactPoint | SMS. The number should be of 10 digits length inv-mr-rp-telecom-mobile-value-01: Mobile Phone must be of 10 digits |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: sms | |
| value |
S | 1..1 | string | The actual contact point details |
| use |
S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile |
| telecom:letter |
S | 0..1 | ContactPoint | Letter |
| system |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: other |
| value |
0..0 | |||
| use |
S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | AUBaseRelatedPerson | A person related to a patient in an Australian healthcare context | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
SΣ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier, AUIHI, AUMedicareCardNumber, AUDVANumber, AUHealthCareCardNumber, AUPensionerConcessionCardNumber, AUCwlthSeniorsHealthCardNumber, AUMedicalRecordNumber, AUInsuranceMemberNumber | A human identifier for this person | |||||
| active |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||
| patient |
SΣ | 1..1 | Reference(MR Patient) | The patient this person is related to | ||||
| relationship |
SΣ | 1..* | CodeableConcept | The nature of the relationship Binding: Related Person Relationship Type (extensible) | ||||
| name |
Σ | 1..* | HumanName | A name associated with the person | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text |
SΣ | 0..1 | string | Text representation of the full name Max Length:100 | ||||
| family |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given |
Σ | 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 | ||||
| prefix |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
| Slices for telecom |
Σ | 0..* | ContactPoint | A contact detail for the person Slice: Unordered, Open by value:use, value:system | ||||
| telecom:email |
SΣC | 0..1 | ContactPoint | Email inv-mr-rp-telecom-email-value-01: Please Provide a valid email id | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
| value |
SΣ | 1..1 | string | The actual contact point details Max Length:100 | ||||
| use |
?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:homePhone |
SΣC | 0..1 | ContactPoint | Home Phone. The number should be of 10 digits length inv-mr-rp-telecom-home-value-01: Home Phone must be of 10 digits | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value |
SΣ | 1..1 | string | The actual contact point details | ||||
| use |
?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:workPhone |
SΣC | 0..1 | ContactPoint | Work Phone. The number should be of 10 digits length inv-mr-rp-telecom-work-value-01: Work Phone must be of 10 digits | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value |
SΣ | 1..1 | string | The actual contact point details | ||||
| use |
?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:mobile |
SΣC | 0..1 | ContactPoint | Mobile. The number should be of 10 digits length inv-mr-rp-telecom-mobile-value-01: Mobile Phone must be of 10 digits | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value |
SΣ | 1..1 | string | The actual contact point details | ||||
| use |
?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:sms |
SΣC | 0..1 | ContactPoint | SMS. The number should be of 10 digits length inv-mr-rp-telecom-mobile-value-01: Mobile Phone must be of 10 digits | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: sms | ||||
| value |
SΣ | 1..1 | string | The actual contact point details | ||||
| use |
?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:letter |
SΣ | 0..1 | ContactPoint | Letter | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: other | ||||
| use |
?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date on which the related person was born | ||||
| address |
0..* | Address, AustralianAddress | Address where the related person can be contacted or visited | |||||
| photo |
0..* | Attachment | Image of the person | |||||
| period |
0..1 | Period | Period of time that this relationship is considered valid | |||||
| communication |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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) | |||||
| preferred |
0..1 | boolean | Language preference indicator | |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code | URI | |||
| RelatedPerson.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| RelatedPerson.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom 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.1from the FHIR Standard | ||||
| RelatedPerson.telecom:email.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| RelatedPerson.telecom:email.use | required | Fixed Value: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| RelatedPerson.telecom:homePhone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| RelatedPerson.telecom:homePhone.use | required | Fixed Value: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| RelatedPerson.telecom:workPhone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| RelatedPerson.telecom:workPhone.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| RelatedPerson.telecom:mobile.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| RelatedPerson.telecom:mobile.use | required | Fixed Value: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| RelatedPerson.telecom:sms.system | required | Fixed Value: smshttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| RelatedPerson.telecom:sms.use | required | Fixed Value: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| RelatedPerson.telecom:letter.system | required | Fixed Value: otherhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| RelatedPerson.telecom:letter.use | required | Fixed Value: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| RelatedPerson.communication.language | extensible | CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| Id | Grade | Path(s) | Details | Requirements |
| 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-mr-rp-telecom-email-value-01 | error | RelatedPerson.telecom:email | Please Provide a valid email id : value.matches('^[a-zA-Z0-9_!#$%&’*+/=?`{|}~^.-]+@[a-zA-Z0-9.-]+$') | |
| inv-mr-rp-telecom-home-value-01 | error | RelatedPerson.telecom:homePhone | Home Phone must be of 10 digits : value.matches('^([0-9]{10})$') | |
| inv-mr-rp-telecom-mobile-value-01 | error | RelatedPerson.telecom:mobile, RelatedPerson.telecom:sms | Mobile Phone must be of 10 digits : value.matches('^([0-9]{10})$') | |
| inv-mr-rp-telecom-work-value-01 | error | RelatedPerson.telecom:workPhone | Work Phone must be of 10 digits : value.matches('^([0-9]{10})$') |