FamilyMemberHistory
Work with FHIR R4 4.0.1 FamilyMemberHistory resources.
Choose an operation for this resource:
- Search FamilyMemberHistory
- Read FamilyMemberHistory
- Read FamilyMemberHistory Version
- Create FamilyMemberHistory
- Update FamilyMemberHistory
- Delete FamilyMemberHistory
- Hard Delete FamilyMemberHistory
- Purge Deleted FamilyMemberHistory
The diagram summarizes FamilyMemberHistory requests and responses. See Supported FHIR REST Interactions for the shared interaction model.
FHIR R4 definition: https://hl7.org/fhir/R4/familymemberhistory.html. See interaction response codes and common error responses.
The resource endpoint is /api/fhir/r4/FamilyMemberHistory. This resource is not available on the R6 API. Consult the live CapabilityStatement for the deployed version's capabilities.
Interactions and responses
- Resource lifecycle: shared
POST,GET,PUT,DELETEandvreadbehavior, version history andIf-Matchpreconditions. - PUT-as-create and restoration:
PUToutcomes, version metadata,ETag,Last-Modified,LocationandPreferreturn preferences. - Interaction responses and common error responses: shared success and error
statuscodes. - Batch requests: independent entry processing and batch limitations.
| FamilyMemberHistory capability | Support |
|---|---|
| Conditional create | Not supported. |
| Conditional update | Not supported. |
| Transaction bundles | Not supported. |
Content and validation
| Field or content | FamilyMemberHistory requirement |
|---|---|
status | Required: partial, completed, entered-in-error, health-unknown. |
patient | Required reference to a Patient. |
relationship | Required relationship to the patient. |
condition.code | Required for every supplied condition. |
| Choice elements | Supply at most one representation for each choice element. |
age[x] and born[x] | Supply at most one choice value; do not supply both age and born content. |
estimatedAge | Requires age[x], including when estimatedAge is false. |
| Resource content | Primitive extensions, repeated codings, condition details and supported contained resources are retained. |
| Write provenance | Successful changes generate related Provenance. |
For shared validation-error responses, see OperationOutcome errors. For server-managed version metadata, see PUT-as-create and restoration.
{"resourceType":"FamilyMemberHistory","status":"completed","patient":{"reference":"Patient/synthetic-patient"},"relationship":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"MTH"}]},"condition":[{"code":{"coding":[{"system":"http://snomed.info/sct","code":"254837009"}]}}]}Search
See Search FamilyMemberHistory for GET and form-encoded POST /_search, the complete parameter table and request examples.
| Filter | Resource field | FamilyMemberHistory behavior |
|---|---|---|
identifier | identifier | Matches top-level identifiers; accepts one unmodified token. |
patient | patient | Matches a Patient reference; :identifier is supported, without additional chaining. |
status | status | Accepts one unmodified status token. |
code | condition.code | Matches any coding in a supplied condition; accepts one unmodified token. |
relationship | relationship | Matches the resource relationship; accepts one unmodified token. |
| Unsupported searches | — | date and sex filters; instantiates, context, clinician and detailed searches; additional chains, composites and full-text search. |
- For
_id,_lastUpdated,_count,_total,_profile,_tagand server-providedBundle.linkpaging, see Common Search Controls. - For value syntax, comparators and modifiers, see Value Types and Syntax and Comparators, Modifiers, and Chains. Use only the forms listed on the FamilyMemberHistory Search page.
- For supported reverse inclusion, see the
_revincluderow on Search FamilyMemberHistory.
GET /api/fhir/r4/FamilyMemberHistory?patient=Patient/synthetic-patient&code=254837009&relationship=MTH&status=completed&_lastUpdated=ge2026-01-01&_lastUpdated=lt2027-01-01Authorization and permanent deletion
- For bearer tokens, scope syntax, client grants and token requests, see Authentication and Scopes. Required FamilyMemberHistory scopes are listed in the operation pages above.
- For permanent-deletion eligibility, additional authorization and irreversible removal, see Data Deletion and Purge Operations.
- For
$hardDelete, use Hard Delete FamilyMemberHistory. - For
$purgeDeletedand itsbeforeandlimitparameters, use Purge Deleted FamilyMemberHistory and the shared purge guidance.