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

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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a FamilyMemberHistory resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(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.
instantiatesCanonicalarray(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.
instantiatesUriarray(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.
statuspartial|completed|entered-in-error|health-unknownA code specifying the status of the record of the family history of a specific family member.
dataAbsentReasonCodeableConceptDescribes why the family member's history is not available.
patient*ReferenceThe person who this history concerns.
datedateTimeThe date (and possibly time) when the family member history was recorded or last updated.
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.).
sexCodeableConceptThe birth sex of the family member.
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/4/FamilyMemberHistory/{resourceId}

Significant health 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*This is a FamilyMemberHistory resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(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.
instantiatesCanonicalarray(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.
instantiatesUriarray(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.
statuspartial|completed|entered-in-error|health-unknownA code specifying the status of the record of the family history of a specific family member.
dataAbsentReasonCodeableConceptDescribes why the family member's history is not available.
patient*ReferenceThe person who this history concerns.
datedateTimeThe date (and possibly time) when the family member history was recorded or last updated.
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.).
sexCodeableConceptThe birth sex of the family member.
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/4/FamilyMemberHistory/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/FamilyMemberHistory/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/FamilyMemberHistory/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/FamilyMemberHistory/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/FamilyMemberHistory

Request

Headers

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

Query params

_idstring
_languagestring
codestring
datestring
identifierstring
instantiates-canonicalstring
instantiates-uristring
patientstring
relationshipstring
sexstring
statusstring

Params

organizationId*string|stringid|slug

Response

Search History Family Member History

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/FamilyMemberHistory/_search

Significant health 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
identifierstring
instantiates-canonicalstring
instantiates-uristring
patientstring
relationshipstring
sexstring
statusstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a FamilyMemberHistory resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(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.
instantiatesCanonicalarray(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.
instantiatesUriarray(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.
statuspartial|completed|entered-in-error|health-unknownA code specifying the status of the record of the family history of a specific family member.
dataAbsentReasonCodeableConceptDescribes why the family member's history is not available.
patient*ReferenceThe person who this history concerns.
datedateTimeThe date (and possibly time) when the family member history was recorded or last updated.
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.).
sexCodeableConceptThe birth sex of the family member.
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/4/FamilyMemberHistory/{resourceId}

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a FamilyMemberHistory resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(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.
instantiatesCanonicalarray(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.
instantiatesUriarray(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.
statuspartial|completed|entered-in-error|health-unknownA code specifying the status of the record of the family history of a specific family member.
dataAbsentReasonCodeableConceptDescribes why the family member's history is not available.
patient*ReferenceThe person who this history concerns.
datedateTimeThe date (and possibly time) when the family member history was recorded or last updated.
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.).
sexCodeableConceptThe birth sex of the family member.
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