family member historys

Create Family Member History

post

/organizations/{organizationId}/fhir/4/FamilyMemberHistory

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

Request

Headers


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

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a FamilyMemberHistory resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
instantiatesCanonical	array(canonical)		The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
instantiatesUri	array(uri)		The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
status		partial\|completed\|entered-in-error\|health-unknown	A code specifying the status of the record of the family history of a specific family member.
dataAbsentReason	CodeableConcept		Describes why the family member's history is not available.
patient*	Reference		The person who this history concerns.
date	dateTime		The date (and possibly time) when the family member history was recorded or last updated.
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.).
sex	CodeableConcept		The birth sex of the family member.
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/4/FamilyMemberHistory/{resourceId}

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

Request

Headers

Params


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

Body


resourceType*			This is a FamilyMemberHistory resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
instantiatesCanonical	array(canonical)		The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
instantiatesUri	array(uri)		The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
status		partial\|completed\|entered-in-error\|health-unknown	A code specifying the status of the record of the family history of a specific family member.
dataAbsentReason	CodeableConcept		Describes why the family member's history is not available.
patient*	Reference		The person who this history concerns.
date	dateTime		The date (and possibly time) when the family member history was recorded or last updated.
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.).
sex	CodeableConcept		The birth sex of the family member.
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/4/FamilyMemberHistory/{resourceId}

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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/4/FamilyMemberHistory/{resourceId}/_history

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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/4/FamilyMemberHistory/{resourceId}/_history/{versionId}

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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/4/FamilyMemberHistory/{resourceId}

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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/4/FamilyMemberHistory

Request

Headers


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

Query params

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Family Member History

get

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

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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/4/FamilyMemberHistory/_search

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

Request

Headers


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

Query params

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a FamilyMemberHistory resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
instantiatesCanonical	array(canonical)		The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
instantiatesUri	array(uri)		The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
status		partial\|completed\|entered-in-error\|health-unknown	A code specifying the status of the record of the family history of a specific family member.
dataAbsentReason	CodeableConcept		Describes why the family member's history is not available.
patient*	Reference		The person who this history concerns.
date	dateTime		The date (and possibly time) when the family member history was recorded or last updated.
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.).
sex	CodeableConcept		The birth sex of the family member.
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/4/FamilyMemberHistory/{resourceId}

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

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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*			This is a FamilyMemberHistory resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
instantiatesCanonical	array(canonical)		The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
instantiatesUri	array(uri)		The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
status		partial\|completed\|entered-in-error\|health-unknown	A code specifying the status of the record of the family history of a specific family member.
dataAbsentReason	CodeableConcept		Describes why the family member's history is not available.
patient*	Reference		The person who this history concerns.
date	dateTime		The date (and possibly time) when the family member history was recorded or last updated.
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.).
sex	CodeableConcept		The birth sex of the family member.
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