Virtually Healthcare HL7 FHIR R4 Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR R4 Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR R4 Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/HL7-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir.virtually.healthcare/StructureDefinition/RelatedPerson | Version: 0.1.0-current | |||
| Draft as of 2024-12-02 | Computable Name: RelatedPerson | |||
Extension of UKCore-RelatedPerson
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from UKCoreRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedPerson |
0..* | UKCoreRelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
  relationship |
||||
 coding |
0..* | Coding | Code defined by a terminology system Binding: PDS RelatedPerson Relationship Type (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship.coding | required | PDSRelatedPersonRelationshipTypehttps://fhir.virtually.healthcare/ValueSet/PDSRelatedPersonRelationshipTypefrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson |
0..* | UKCoreRelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 Slices for extension |
Content/Rules for all slices | |||
   contactPreference |
N | 0..1 | (Complex) | The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference |
 copyCorrespondenceIndicator |
N | 0..1 | boolean | Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator |
 modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| active |
?!SΣ | 0..1 | boolean | Whether this related person's record is in active use. |
 patient |
SΣC | 1..1 | Reference(Patient) | The patient this person is related to. ref-1: SHALL have a contained resource if a local reference is provided |
 relationship |
SΣ | 0..* | CodeableConcept | The nature of the relationship. Binding: UK Core Person Relationship Type (extensible): The nature of the relationship between a patient and the related person. |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: PDS RelatedPerson Relationship Type (required) |
| name |
SΣ | 0..* | HumanName | A name associated with the person. |
| telecom |
SΣC | 0..* | ContactPoint | A contact detail for the person. cpt-2: A system is required if a value is provided. |
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| Slices for extension |
Content/Rules for all slices | |||
| otherContactSystem |
N | 0..1 | CodeableConcept | Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| address |
SΣ | 0..* | Address | Address where the related person can be contacted or visited. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship | extensible | UKCorePersonRelationshipTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType | |
| RelatedPerson.relationship.coding | required | PDSRelatedPersonRelationshipTypehttps://fhir.virtually.healthcare/ValueSet/PDSRelatedPersonRelationshipTypefrom this IG | |
| RelatedPerson.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| RelatedPerson.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | UKCoreRelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 | |||||
 Slices for extension |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| contactPreference |
N | 0..1 | (Complex) | The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference | ||||
| copyCorrespondenceIndicator |
N | 0..1 | boolean | Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator | ||||
| modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier |
Σ | 0..* | Identifier | A human identifier for this person | ||||
| active |
?!SΣ | 0..1 | boolean | Whether this related person's record is in active use. | ||||
| patient |
SΣC | 1..1 | Reference(Patient) | The patient this person is related to. ref-1: SHALL have a contained resource if a local reference is provided | ||||
| relationship |
SΣ | 0..* | CodeableConcept | The nature of the relationship. Binding: UK Core Person Relationship Type (extensible): The nature of the relationship between a patient and the related 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 | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: PDS RelatedPerson Relationship Type (required) | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| name |
SΣ | 0..* | HumanName | A name associated with the person. | ||||
| telecom |
SΣC | 0..* | ContactPoint | A contact detail for the person. cpt-2: A system is required if a value is provided. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| otherContactSystem |
N | 0..1 | CodeableConcept | Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) | ||||
| value |
0..1 | code | Primitive value for code Max Length:1048576 | |||||
| value |
Σ | 0..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
ΣC | 0..1 | Period | Time period when the contact point was/is in use per-1: If present, start SHALL have a lower value than end | ||||
| 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 |
SΣ | 0..* | Address | Address where the related person can be contacted or visited. | ||||
| photo |
C | 0..* | Attachment | Image of the person att-1: If the Attachment has data, it SHALL have a contentType | ||||
| period |
C | 0..1 | Period | Period of time that this relationship is considered valid per-1: If present, start SHALL have a lower value than end | ||||
| 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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: AllLanguages (required): A language which may be used to communicate with the related person about the patient's health.
| |||||
| preferred |
0..1 | boolean | Language preference indicator | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| RelatedPerson.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| RelatedPerson.relationship | extensible | UKCorePersonRelationshipTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType | ||||
| RelatedPerson.relationship.coding | required | PDSRelatedPersonRelationshipTypehttps://fhir.virtually.healthcare/ValueSet/PDSRelatedPersonRelationshipTypefrom this IG | ||||
| RelatedPerson.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| RelatedPerson.telecom.use | required | ContactPointUsehttp://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 | required | AllLanguages
http://hl7.org/fhir/ValueSet/all-languagesfrom the FHIR Standard |
This structure is derived from UKCoreRelatedPerson
Differential View
This structure is derived from UKCoreRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson |
0..* | UKCoreRelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
| relationship |
||||
| coding |
0..* | Coding | Code defined by a terminology system Binding: PDS RelatedPerson Relationship Type (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship.coding | required | PDSRelatedPersonRelationshipTypehttps://fhir.virtually.healthcare/ValueSet/PDSRelatedPersonRelationshipTypefrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson |
0..* | UKCoreRelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| contactPreference |
N | 0..1 | (Complex) | The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference |
| copyCorrespondenceIndicator |
N | 0..1 | boolean | Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator |
| modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| active |
?!SΣ | 0..1 | boolean | Whether this related person's record is in active use. |
| patient |
SΣC | 1..1 | Reference(Patient) | The patient this person is related to. ref-1: SHALL have a contained resource if a local reference is provided |
| relationship |
SΣ | 0..* | CodeableConcept | The nature of the relationship. Binding: UK Core Person Relationship Type (extensible): The nature of the relationship between a patient and the related person. |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: PDS RelatedPerson Relationship Type (required) |
| name |
SΣ | 0..* | HumanName | A name associated with the person. |
| telecom |
SΣC | 0..* | ContactPoint | A contact detail for the person. cpt-2: A system is required if a value is provided. |
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| Slices for extension |
Content/Rules for all slices | |||
| otherContactSystem |
N | 0..1 | CodeableConcept | Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| address |
SΣ | 0..* | Address | Address where the related person can be contacted or visited. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship | extensible | UKCorePersonRelationshipTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType | |
| RelatedPerson.relationship.coding | required | PDSRelatedPersonRelationshipTypehttps://fhir.virtually.healthcare/ValueSet/PDSRelatedPersonRelationshipTypefrom this IG | |
| RelatedPerson.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| RelatedPerson.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | UKCoreRelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 | |||||
| Slices for extension |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| contactPreference |
N | 0..1 | (Complex) | The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference | ||||
| copyCorrespondenceIndicator |
N | 0..1 | boolean | Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator | ||||
| modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier |
Σ | 0..* | Identifier | A human identifier for this person | ||||
| active |
?!SΣ | 0..1 | boolean | Whether this related person's record is in active use. | ||||
| patient |
SΣC | 1..1 | Reference(Patient) | The patient this person is related to. ref-1: SHALL have a contained resource if a local reference is provided | ||||
| relationship |
SΣ | 0..* | CodeableConcept | The nature of the relationship. Binding: UK Core Person Relationship Type (extensible): The nature of the relationship between a patient and the related 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 | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system Binding: PDS RelatedPerson Relationship Type (required) | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| name |
SΣ | 0..* | HumanName | A name associated with the person. | ||||
| telecom |
SΣC | 0..* | ContactPoint | A contact detail for the person. cpt-2: A system is required if a value is provided. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| otherContactSystem |
N | 0..1 | CodeableConcept | Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) | ||||
| value |
0..1 | code | Primitive value for code Max Length:1048576 | |||||
| value |
Σ | 0..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
ΣC | 0..1 | Period | Time period when the contact point was/is in use per-1: If present, start SHALL have a lower value than end | ||||
| 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 |
SΣ | 0..* | Address | Address where the related person can be contacted or visited. | ||||
| photo |
C | 0..* | Attachment | Image of the person att-1: If the Attachment has data, it SHALL have a contentType | ||||
| period |
C | 0..1 | Period | Period of time that this relationship is considered valid per-1: If present, start SHALL have a lower value than end | ||||
| 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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: AllLanguages (required): A language which may be used to communicate with the related person about the patient's health.
| |||||
| preferred |
0..1 | boolean | Language preference indicator | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| RelatedPerson.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| RelatedPerson.relationship | extensible | UKCorePersonRelationshipTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType | ||||
| RelatedPerson.relationship.coding | required | PDSRelatedPersonRelationshipTypehttps://fhir.virtually.healthcare/ValueSet/PDSRelatedPersonRelationshipTypefrom this IG | ||||
| RelatedPerson.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| RelatedPerson.telecom.use | required | ContactPointUsehttp://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 | required | AllLanguages
http://hl7.org/fhir/ValueSet/all-languagesfrom the FHIR Standard |
This structure is derived from UKCoreRelatedPerson
Other representations of profile: CSV, Excel, Schematron