Related Person
Options to work with FHIR R4 Related Person resources.
See also
For permanent deletion guidance, see Data deletion and purge operations.
Options to work with FHIR R4 Related Person resources.
RelatedPerson identifies a person related to the Patient (guardian, spouse, caregiver, etc.). Core relationship:
+----------------------+ patient.reference +-----------------+
| RelatedPerson (R4) | ----------------------> | Patient (R4) |
| id, relationship[] | | id |
| patient | +-----------------+
+----------------------+
Optional context (Observation performer):
+------------------+ performer[] +----------------------+
| Observation (R4) | ------------------------> | RelatedPerson (R4) |
+------------------+ +----------------------+
Search flow returning RelatedPerson records by patient:
Client FHIR API
| GET /api/fhir/r4/RelatedPerson |
| ?patient=Patient/{patient-id} |
|------------------------------------------->|
| 200 Bundle (type=searchset) |
|<-------------------------------------------|
RelatedPerson supports primitive companion elements in underscore form for selected fields:
_active, _birthDate, _gender, _implicitRules, _language.
For JSON usage patterns, see FHIR primitive extensions in JSON.
This table lists successful HTTP responses for this resource.
| Endpoint | Method | Successful status code |
|---|---|---|
/api/fhir/r4/RelatedPerson |
GET | 200 |
/api/fhir/r4/RelatedPerson |
POST | 201 |
/api/fhir/r4/RelatedPerson/$purgeDeleted |
POST | 200 |
/api/fhir/r4/RelatedPerson/{rid} |
DELETE | 204 |
/api/fhir/r4/RelatedPerson/{rid} |
GET | 200 |
/api/fhir/r4/RelatedPerson/{rid} |
PUT | 200 |
/api/fhir/r4/RelatedPerson/{rid}/$hardDelete |
POST | 200 |
/api/fhir/r4/RelatedPerson/{rid}/_history/{vid} |
GET | 200 |
For cross-resource interaction summaries, see FHIR status codes.
For permanent deletion guidance, see Data deletion and purge operations.