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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringFamilyMemberHistoryThis is a FamilyMemberHistory resource
identifierarray(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).
definitionarray(Reference)A protocol or questionnaire that was adhered to in whole or in part by this event.
statusstringpartial|completed|entered-in-error|health-unknownA code specifying the status of the record of the family history of a specific family member.
notDonebooleanIf 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.
notDoneReasonCodeableConceptDescribes why the family member's history is absent.
patient*ReferenceThe person who this history concerns.
datestringThe date (and possibly time) when the family member history was taken.
namestringThis will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
relationship*CodeableConceptThe type of relationship this person has to the patient (father, mother, brother etc.).
genderstringmale|female|other|unknownAdministrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
bornPeriodPeriodThe actual or approximate date of birth of the relative.
bornDatestringThe actual or approximate date of birth of the relative.
bornStringstringThe actual or approximate date of birth of the relative.
ageAgeAgeThe age of the relative at the time the family member history is recorded.
ageRangeRangeThe age of the relative at the time the family member history is recorded.
ageStringstringThe age of the relative at the time the family member history is recorded.
estimatedAgebooleanIf true, indicates that the age value specified is an estimated value.
deceasedBooleanbooleanDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedAgeAgeDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedRangeRangeDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedDatestringDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedStringstringDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
reasonCodearray(CodeableConcept)Describes why the family member history occurred in coded or textual form.
reasonReferencearray(Reference)Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
notearray(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.
conditionarray(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

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringFamilyMemberHistoryThis is a FamilyMemberHistory resource
identifierarray(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).
definitionarray(Reference)A protocol or questionnaire that was adhered to in whole or in part by this event.
statusstringpartial|completed|entered-in-error|health-unknownA code specifying the status of the record of the family history of a specific family member.
notDonebooleanIf 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.
notDoneReasonCodeableConceptDescribes why the family member's history is absent.
patient*ReferenceThe person who this history concerns.
datestringThe date (and possibly time) when the family member history was taken.
namestringThis will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
relationship*CodeableConceptThe type of relationship this person has to the patient (father, mother, brother etc.).
genderstringmale|female|other|unknownAdministrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
bornPeriodPeriodThe actual or approximate date of birth of the relative.
bornDatestringThe actual or approximate date of birth of the relative.
bornStringstringThe actual or approximate date of birth of the relative.
ageAgeAgeThe age of the relative at the time the family member history is recorded.
ageRangeRangeThe age of the relative at the time the family member history is recorded.
ageStringstringThe age of the relative at the time the family member history is recorded.
estimatedAgebooleanIf true, indicates that the age value specified is an estimated value.
deceasedBooleanbooleanDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedAgeAgeDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedRangeRangeDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedDatestringDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedStringstringDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
reasonCodearray(CodeableConcept)Describes why the family member history occurred in coded or textual form.
reasonReferencearray(Reference)Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
notearray(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.
conditionarray(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

Read Family Member History

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Family Member History

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Family Member History

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Family Member History

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Family Member History

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
codestring
datestring
definitionstring
genderstring
identifierstring
patientstring
relationshipstring
statusstring

Params

organizationId*string|stringid|slug

Response

Search History Family Member History

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
codestring
datestring
definitionstring
genderstring
identifierstring
patientstring
relationshipstring
statusstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringFamilyMemberHistoryThis is a FamilyMemberHistory resource
identifierarray(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).
definitionarray(Reference)A protocol or questionnaire that was adhered to in whole or in part by this event.
statusstringpartial|completed|entered-in-error|health-unknownA code specifying the status of the record of the family history of a specific family member.
notDonebooleanIf 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.
notDoneReasonCodeableConceptDescribes why the family member's history is absent.
patient*ReferenceThe person who this history concerns.
datestringThe date (and possibly time) when the family member history was taken.
namestringThis will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
relationship*CodeableConceptThe type of relationship this person has to the patient (father, mother, brother etc.).
genderstringmale|female|other|unknownAdministrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
bornPeriodPeriodThe actual or approximate date of birth of the relative.
bornDatestringThe actual or approximate date of birth of the relative.
bornStringstringThe actual or approximate date of birth of the relative.
ageAgeAgeThe age of the relative at the time the family member history is recorded.
ageRangeRangeThe age of the relative at the time the family member history is recorded.
ageStringstringThe age of the relative at the time the family member history is recorded.
estimatedAgebooleanIf true, indicates that the age value specified is an estimated value.
deceasedBooleanbooleanDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedAgeAgeDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedRangeRangeDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedDatestringDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedStringstringDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
reasonCodearray(CodeableConcept)Describes why the family member history occurred in coded or textual form.
reasonReferencearray(Reference)Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
notearray(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.
conditionarray(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

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringFamilyMemberHistoryThis is a FamilyMemberHistory resource
identifierarray(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).
definitionarray(Reference)A protocol or questionnaire that was adhered to in whole or in part by this event.
statusstringpartial|completed|entered-in-error|health-unknownA code specifying the status of the record of the family history of a specific family member.
notDonebooleanIf 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.
notDoneReasonCodeableConceptDescribes why the family member's history is absent.
patient*ReferenceThe person who this history concerns.
datestringThe date (and possibly time) when the family member history was taken.
namestringThis will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
relationship*CodeableConceptThe type of relationship this person has to the patient (father, mother, brother etc.).
genderstringmale|female|other|unknownAdministrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
bornPeriodPeriodThe actual or approximate date of birth of the relative.
bornDatestringThe actual or approximate date of birth of the relative.
bornStringstringThe actual or approximate date of birth of the relative.
ageAgeAgeThe age of the relative at the time the family member history is recorded.
ageRangeRangeThe age of the relative at the time the family member history is recorded.
ageStringstringThe age of the relative at the time the family member history is recorded.
estimatedAgebooleanIf true, indicates that the age value specified is an estimated value.
deceasedBooleanbooleanDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedAgeAgeDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedRangeRangeDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedDatestringDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
deceasedStringstringDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
reasonCodearray(CodeableConcept)Describes why the family member history occurred in coded or textual form.
reasonReferencearray(Reference)Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
notearray(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.
conditionarray(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