FamilyMemberHistory

Trial Use 2 Clinical — Summary

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

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/FamilyMemberHistory

Interaction	Method	Path
Read	`GET`	`/fhir/R4/FamilyMemberHistory/[id]`
Vread	`GET`	`/fhir/R4/FamilyMemberHistory/[id]/_history/[vid]`
Update	`PUT`	`/fhir/R4/FamilyMemberHistory/[id]`
Patch	`PATCH`	`/fhir/R4/FamilyMemberHistory/[id]`
Delete	`DELETE`	`/fhir/R4/FamilyMemberHistory/[id]`
Create	`POST`	`/fhir/R4/FamilyMemberHistory`
Search	`GET`	`/fhir/R4/FamilyMemberHistory`
History	`GET`	`/fhir/R4/FamilyMemberHistory/[id]/_history`

Element	Type(s)	Cardinality	Description
`identifier`	`Identifier`	`0..*`	External Id(s) for this record
`instantiatesCanonical`	`canonical`	`0..*`	Instantiates FHIR protocol or definition
`instantiatesUri`	`uri`	`0..*`	Instantiates external protocol or definition
`status`	`code`	`1..1`	partial \| completed \| entered-in-error \| health-unknown modifier
`dataAbsentReason`	`CodeableConcept`	`0..1`	subject-unknown \| withheld \| unable-to-obtain \| deferred
`patient`	`Reference`	`1..1`	Patient history is about
`date`	`dateTime`	`0..1`	When history was recorded or last updated
`name`	`string`	`0..1`	The family member described
`relationship`	`CodeableConcept`	`1..1`	Relationship to the subject
`sex`	`CodeableConcept`	`0..1`	male \| female \| other \| unknown
`born[x]`	`Period` / `date` / `string`	`0..1`	(approximate) date of birth
`age[x]`	`Age` / `Range` / `string`	`0..1`	(approximate) age
`estimatedAge`	`boolean`	`0..1`	Age is estimated?
`deceased[x]`	`boolean` / `Age` / `Range` / `date` / `string`	`0..1`	Dead? How old/when?
`reasonCode`	`CodeableConcept`	`0..*`	Why was family member history performed?
`reasonReference`	`Reference`	`0..*`	Why was family member history performed?
`note`	`Annotation`	`0..*`	General note about related person
`condition`	`BackboneElement`	`0..*`	Condition that the related person had

Parameter	Type	Description
`_compartment`	`string`
`_count`	`string`	https://www.hl7.org/fhir/search.html#_count
`_elements`	`string`	https://www.hl7.org/fhir/search.html#_elements
`_id`	`string`
`_lastUpdated`	`string`
`_profile`	`string`
`_security`	`string`
`_sort`	`string`	https://www.hl7.org/fhir/search.html#_sort
`_source`	`string`
`_summary`	`string`	https://www.hl7.org/fhir/search.html#_summary
`_tag`	`string`
`_total`	`string`	https://www.hl7.org/fhir/search.html#_total
`code`	`string`	http://hl7.org/fhir/SearchParameter/clinical-code
`date`	`string`	http://hl7.org/fhir/SearchParameter/clinical-date
`identifier`	`string`	http://hl7.org/fhir/SearchParameter/clinical-identifier
`instantiates-canonical`	`string`	http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-instantiates-canonical
`instantiates-uri`	`string`	http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-instantiates-uri
`patient`	`string`	http://hl7.org/fhir/SearchParameter/clinical-patient
`relationship`	`string`	http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-relationship
`sex`	`string`	http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-sex
`status`	`string`	http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-status