Release 5 Preview #2

This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4

Extension: relatedPerson

Patient Administration Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/patient-relatedPerson

Status: draft. Extension maintained by: HL7

In some cases a Patient.contact will also be populated as a RelatedPerson resource. This linkage permits the linkage between the 2 resources to be able to accurately indicate a representation of the same individual, and updating details between could be appropriate.

Context of Use: Use on Element ID Patient.contact

Summary

Name	Flags	Card.	Type	Description & Constraints
relatedPerson		0..*	Reference(RelatedPerson)	URL = http://hl7.org/fhir/StructureDefinition/patient-relatedPerson relatedPerson: In some cases a Patient.contact will also be populated as a RelatedPerson resource. This linkage permits the linkage between the 2 resources to be able to accurately indicate a representation of the same individual, and updating details between could be appropriate. Use on Element ID Patient.contact
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-relatedPerson relatedPerson: In some cases a Patient.contact will also be populated as a RelatedPerson resource. This linkage permits the linkage between the 2 resources to be able to accurately indicate a representation of the same individual, and updating details between could be appropriate. Use on Element ID Patient.contact
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-relatedPerson"
value[x]	I	1..1	Reference(RelatedPerson)	Value of extension
Documentation for this format

XML Template

<!-- relatedPerson -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-relatedPerson" >
  <!-- from Element: extension -->
 <valueReference><!--  1..1 Reference(RelatedPerson) Value of extension --></valueReference>
</extension>

JSON Template

{ // relatedPerson
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson", // R! 
    "valueReference" : { Reference(RelatedPerson) } // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
relatedPerson		0..*	Reference(RelatedPerson)	URL = http://hl7.org/fhir/StructureDefinition/patient-relatedPerson relatedPerson: In some cases a Patient.contact will also be populated as a RelatedPerson resource. This linkage permits the linkage between the 2 resources to be able to accurately indicate a representation of the same individual, and updating details between could be appropriate. Use on Element ID Patient.contact
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-relatedPerson relatedPerson: In some cases a Patient.contact will also be populated as a RelatedPerson resource. This linkage permits the linkage between the 2 resources to be able to accurately indicate a representation of the same individual, and updating details between could be appropriate. Use on Element ID Patient.contact
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-relatedPerson"
value[x]	I	1..1	Reference(RelatedPerson)	Value of extension
Documentation for this format

XML Template

<!-- relatedPerson -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-relatedPerson" >
  <!-- from Element: extension -->
 <valueReference><!--  1..1 Reference(RelatedPerson) Value of extension --></valueReference>
</extension>

JSON Template

{ // relatedPerson
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson", // R! 
    "valueReference" : { Reference(RelatedPerson) } // C? R! Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)