RelatedPerson resource implementation guidance
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop applications using the FHIR® CDS API.
Related Person: Implementation Guidance
Usage
Within the Clinical Decision Support API implementation, the RelatedPerson resource is used to convey information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process
The table below gives implementation guidance in relation to the elements within a RelatedPerson:
| Name | Cardinality | Type | FHIR Documentation | CDS Implementation Guidance |
|---|---|---|---|---|
id |
0..1 |
id | Logical id of this artifact | Note that this will always be populated except when the resource is being created (initial creation call) |
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. Common Languages (Extensible but limited to All Languages) |
|
text |
0..1 |
Narrative | Text summary of the resource, for human interpretation | |
contained |
0..* |
Resource | Contained, inline Resources | This SHOULD NOT be populated |
extension |
0..* |
Extension | Additional Content defined by implementations | |
modifierExtension |
0..* |
Extension | Extensions that cannot be ignored | |
identifier |
0..* |
Identifier | A human identifier for this person | |
active |
0..1 |
boolean | Whether this related person's record is in active use | |
patient |
1..1 |
Reference(Patient) | The patient this person is related to | |
relationship |
0..1 |
CodeableConcept | The nature of this relationship PatientRelationshipType (Preferred) |
|
name |
0..* |
HumanName | A name associated with the person | |
telecom |
0..* |
ContactPoint | A contact detail for the person | |
gender |
0..1 |
code | male | female | other | unknown AdministrativeGender (Required) |
|
birthDate |
0..1 |
date | The date on which the related person was born | |
address |
0..* |
Address | 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 |
