family member historys

Create Family Member History

post

/organizations/{organizationId}/fhir/3/FamilyMemberHistory

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	FamilyMemberHistory	This is a FamilyMemberHistory resource
identifier	array(Identifier)		This records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definition	array(Reference)		A protocol or questionnaire that was adhered to in whole or in part by this event.
status	string	partial\|completed\|entered-in-error\|health-unknown	A code specifying the status of the record of the family history of a specific family member.
notDone	boolean		If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.
notDoneReason	CodeableConcept		Describes why the family member's history is absent.
patient*	Reference		The person who this history concerns.
date	string		The date (and possibly time) when the family member history was taken.
name	string		This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
relationship*	CodeableConcept		The type of relationship this person has to the patient (father, mother, brother etc.).
gender	string	male\|female\|other\|unknown	Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
bornPeriod	Period		The actual or approximate date of birth of the relative.
bornDate	string		The actual or approximate date of birth of the relative.
bornString	string		The actual or approximate date of birth of the relative.
ageAge	Age		The age of the relative at the time the family member history is recorded.
ageRange	Range		The age of the relative at the time the family member history is recorded.
ageString	string		The age of the relative at the time the family member history is recorded.
estimatedAge	boolean		If true, indicates that the age value specified is an estimated value.
deceasedBoolean	boolean		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedAge	Age		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedRange	Range		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedDate	string		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedString	string		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
reasonCode	array(CodeableConcept)		Describes why the family member history occurred in coded or textual form.
reasonReference	array(Reference)		Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
note	array(Annotation)		This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.
condition	array(FamilyMemberHistory_Condition)		The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

Response

201 400 401 404

Patch Family Member History

patch

/organizations/{organizationId}/fhir/3/FamilyMemberHistory/{resourceId}

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

Request

Headers


content-type*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	FamilyMemberHistory	This is a FamilyMemberHistory resource
identifier	array(Identifier)		This records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definition	array(Reference)		A protocol or questionnaire that was adhered to in whole or in part by this event.
status	string	partial\|completed\|entered-in-error\|health-unknown	A code specifying the status of the record of the family history of a specific family member.
notDone	boolean		If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.
notDoneReason	CodeableConcept		Describes why the family member's history is absent.
patient*	Reference		The person who this history concerns.
date	string		The date (and possibly time) when the family member history was taken.
name	string		This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
relationship*	CodeableConcept		The type of relationship this person has to the patient (father, mother, brother etc.).
gender	string	male\|female\|other\|unknown	Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
bornPeriod	Period		The actual or approximate date of birth of the relative.
bornDate	string		The actual or approximate date of birth of the relative.
bornString	string		The actual or approximate date of birth of the relative.
ageAge	Age		The age of the relative at the time the family member history is recorded.
ageRange	Range		The age of the relative at the time the family member history is recorded.
ageString	string		The age of the relative at the time the family member history is recorded.
estimatedAge	boolean		If true, indicates that the age value specified is an estimated value.
deceasedBoolean	boolean		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedAge	Age		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedRange	Range		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedDate	string		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedString	string		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
reasonCode	array(CodeableConcept)		Describes why the family member history occurred in coded or textual form.
reasonReference	array(Reference)		Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
note	array(Annotation)		This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.
condition	array(FamilyMemberHistory_Condition)		The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

Response

200 201 400 401 404 409

Read Family Member History

get

/organizations/{organizationId}/fhir/3/FamilyMemberHistory/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Family Member History

get

/organizations/{organizationId}/fhir/3/FamilyMemberHistory/{resourceId}/_history

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Family Member History

get

/organizations/{organizationId}/fhir/3/FamilyMemberHistory/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Family Member History

delete

/organizations/{organizationId}/fhir/3/FamilyMemberHistory/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Family Member History

get

/organizations/{organizationId}/fhir/3/FamilyMemberHistory

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
code	string
date	string
definition	string
gender	string
identifier	string
patient	string
relationship	string
status	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Family Member History

get

/organizations/{organizationId}/fhir/3/FamilyMemberHistory/_history

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Family Member History

post

/organizations/{organizationId}/fhir/3/FamilyMemberHistory/_search

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

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
code	string
date	string
definition	string
gender	string
identifier	string
patient	string
relationship	string
status	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	FamilyMemberHistory	This is a FamilyMemberHistory resource
identifier	array(Identifier)		This records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definition	array(Reference)		A protocol or questionnaire that was adhered to in whole or in part by this event.
status	string	partial\|completed\|entered-in-error\|health-unknown	A code specifying the status of the record of the family history of a specific family member.
notDone	boolean		If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.
notDoneReason	CodeableConcept		Describes why the family member's history is absent.
patient*	Reference		The person who this history concerns.
date	string		The date (and possibly time) when the family member history was taken.
name	string		This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
relationship*	CodeableConcept		The type of relationship this person has to the patient (father, mother, brother etc.).
gender	string	male\|female\|other\|unknown	Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
bornPeriod	Period		The actual or approximate date of birth of the relative.
bornDate	string		The actual or approximate date of birth of the relative.
bornString	string		The actual or approximate date of birth of the relative.
ageAge	Age		The age of the relative at the time the family member history is recorded.
ageRange	Range		The age of the relative at the time the family member history is recorded.
ageString	string		The age of the relative at the time the family member history is recorded.
estimatedAge	boolean		If true, indicates that the age value specified is an estimated value.
deceasedBoolean	boolean		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedAge	Age		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedRange	Range		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedDate	string		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedString	string		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
reasonCode	array(CodeableConcept)		Describes why the family member history occurred in coded or textual form.
reasonReference	array(Reference)		Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
note	array(Annotation)		This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.
condition	array(FamilyMemberHistory_Condition)		The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

Response

200 401 404

Update Family Member History

put

/organizations/{organizationId}/fhir/3/FamilyMemberHistory/{resourceId}

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	FamilyMemberHistory	This is a FamilyMemberHistory resource
identifier	array(Identifier)		This records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definition	array(Reference)		A protocol or questionnaire that was adhered to in whole or in part by this event.
status	string	partial\|completed\|entered-in-error\|health-unknown	A code specifying the status of the record of the family history of a specific family member.
notDone	boolean		If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.
notDoneReason	CodeableConcept		Describes why the family member's history is absent.
patient*	Reference		The person who this history concerns.
date	string		The date (and possibly time) when the family member history was taken.
name	string		This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
relationship*	CodeableConcept		The type of relationship this person has to the patient (father, mother, brother etc.).
gender	string	male\|female\|other\|unknown	Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
bornPeriod	Period		The actual or approximate date of birth of the relative.
bornDate	string		The actual or approximate date of birth of the relative.
bornString	string		The actual or approximate date of birth of the relative.
ageAge	Age		The age of the relative at the time the family member history is recorded.
ageRange	Range		The age of the relative at the time the family member history is recorded.
ageString	string		The age of the relative at the time the family member history is recorded.
estimatedAge	boolean		If true, indicates that the age value specified is an estimated value.
deceasedBoolean	boolean		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedAge	Age		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedRange	Range		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedDate	string		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedString	string		Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
reasonCode	array(CodeableConcept)		Describes why the family member history occurred in coded or textual form.
reasonReference	array(Reference)		Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
note	array(Annotation)		This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.
condition	array(FamilyMemberHistory_Condition)		The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

Response

200 201 400 401 404 409