FamilyMemberHistory

ResourceClinical · SummaryTrial useMaturity 2

Significant health conditions for a person related to the patient relevant in the context of care for the patient.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

9 of 9 parameters tested

Structure

Show inherited elements (11)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	External Id(s) for this record
instantiatesCanonicalΣ	0..*	canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUriΣ	0..*	uri	Instantiates external protocol or definition
statusRequired?!Σ	1..1	code	partial | completed | entered-in-error | health-unknownBinding (required): history-status
dataAbsentReasonΣ	0..1	CodeableConcept	subject-unknown | withheld | unable-to-obtain | deferredBinding (example): history-absent-reason
patientRequiredΣ	1..1	Reference(Patient)	Patient history is about
dateΣ	0..1	dateTime	When history was recorded or last updated
nameΣ	0..1	string	The family member described
relationshipRequiredΣ	1..1	CodeableConcept	Relationship to the subjectBinding (example): v3-FamilyMember
sexΣ	0..1	CodeableConcept	male | female | other | unknownBinding (extensible): administrative-gender
born[x]	0..1	Period | date | string	(approximate) date of birth
age[x]Σ	0..1	Age | Range | string	(approximate) age
estimatedAgeΣ	0..1	boolean	Age is estimated?
deceased[x]Σ	0..1	boolean | Age | Range | date | string	Dead? How old/when?
reasonCodeΣ	0..*	CodeableConcept	Why was family member history performed?Binding (example): clinical-findings
reasonReferenceΣ	0..*	Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)	Why was family member history performed?
note	0..*	Annotation	General note about related person
condition	0..*	BackboneElement	Condition that the related person had
codeRequired	1..1	CodeableConcept	Condition suffered by relationBinding (example): condition-code
outcome	0..1	CodeableConcept	deceased | permanent disability | etc.Binding (example): condition-outcome
contributedToDeath	0..1	boolean	Whether the condition contributed to the cause of death
onset[x]	0..1	Age | Range | Period | string	When condition first manifested
note	0..*	Annotation	Extra information about condition

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/FamilyMemberHistory?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
code	token	A search by a condition code FamilyMemberHistory.condition.code
date	date	When history was recorded or last updated FamilyMemberHistory.date
identifier	token	A search by a record identifier FamilyMemberHistory.identifier
instantiates-canonical	reference	Instantiates FHIR protocol or definition FamilyMemberHistory.instantiatesCanonical
instantiates-uri	uri	Instantiates external protocol or definition FamilyMemberHistory.instantiatesUri
patient	reference	The identity of a subject to list family member history items for FamilyMemberHistory.patient
relationship	token	A search by a relationship type FamilyMemberHistory.relationship
sex	token	A search by a sex code of a family member FamilyMemberHistory.sex
status	token	partial | completed | entered-in-error | health-unknown FamilyMemberHistory.status

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition