Release 5
This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Patient Care Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Patient |
This is a representation of the json schema for FamilyMemberHistory, which is just a part of the full JSON Schema.
Clinical Summary
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/FamilyMemberHistory",
"$ref": "#/definitions/FamilyMemberHistory",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"FamilyMemberHistory": {
"description": "Significant health conditions for a person related to the patient relevant in the context of care for the patient.",
"properties": {
"resourceType": {
"description": "This is a FamilyMemberHistory resource",
"const": "FamilyMemberHistory"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "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.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "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.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "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.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "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 managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"instantiatesCanonical": {
"description": "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.",
"items": {
"$ref": "canonical.schema.json#/definitions/canonical"
},
"type": "array"
},
"instantiatesUri": {
"description": "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.",
"items": {
"$ref": "#/definitions/uri"
},
"type": "array"
},
"_instantiatesUri": {
"description": "Extensions for instantiatesUri",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"status": {
"description": "A code specifying the status of the record of the family history of a specific family member.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"dataAbsentReason": {
"description": "Describes why the family member\u0027s history is not available.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"patient": {
"description": "The person who this history concerns.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"date": {
"description": "The date (and possibly time) when the family member history was recorded or last updated.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"participant": {
"description": "Indicates who or what participated in the activities related to the family member history and how they were involved.",
"items": {
"$ref": "#/definitions/FamilyMemberHistory_Participant"
},
"type": "array"
},
"name": {
"description": "This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\".",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"relationship": {
"description": "The type of relationship this person has to the patient (father, mother, brother etc.).",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"sex": {
"description": "The birth sex of the family member.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"bornPeriod": {
"description": "The actual or approximate date of birth of the relative.",
"$ref": "Period.schema.json#/definitions/Period"
},
"bornDate": {
"description": "The actual or approximate date of birth of the relative.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_bornDate": {
"description": "Extensions for bornDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"bornString": {
"description": "The actual or approximate date of birth of the relative.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_bornString": {
"description": "Extensions for bornString",
"$ref": "Element.schema.json#/definitions/Element"
},
"ageAge": {
"description": "The age of the relative at the time the family member history is recorded.",
"$ref": "Age.schema.json#/definitions/Age"
},
"ageRange": {
"description": "The age of the relative at the time the family member history is recorded.",
"$ref": "Range.schema.json#/definitions/Range"
},
"ageString": {
"description": "The age of the relative at the time the family member history is recorded.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_ageString": {
"description": "Extensions for ageString",
"$ref": "Element.schema.json#/definitions/Element"
},
"estimatedAge": {
"description": "If true, indicates that the age value specified is an estimated value.",
"$ref": "#/definitions/boolean"
},
"_estimatedAge": {
"description": "Extensions for estimatedAge",
"$ref": "Element.schema.json#/definitions/Element"
},
"deceasedBoolean": {
"description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.",
"pattern": "^true|false$",
"type": "boolean"
},
"_deceasedBoolean": {
"description": "Extensions for deceasedBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"deceasedAge": {
"description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.",
"$ref": "Age.schema.json#/definitions/Age"
},
"deceasedRange": {
"description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.",
"$ref": "Range.schema.json#/definitions/Range"
},
"deceasedDate": {
"description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_deceasedDate": {
"description": "Extensions for deceasedDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"deceasedString": {
"description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_deceasedString": {
"description": "Extensions for deceasedString",
"$ref": "Element.schema.json#/definitions/Element"
},
"reason": {
"description": "Describes why the family member history occurred in coded or textual form, or Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.",
"items": {
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"type": "array"
},
"note": {
"description": "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.",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"type": "array"
},
"condition": {
"description": "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.",
"items": {
"$ref": "#/definitions/FamilyMemberHistory_Condition"
},
"type": "array"
},
"procedure": {
"description": "The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure.",
"items": {
"$ref": "#/definitions/FamilyMemberHistory_Procedure"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"patient",
"relationship",
"resourceType"
]
},
"FamilyMemberHistory_Participant": {
"description": "Significant health conditions for a person related to the patient relevant in the context of care for the patient.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"function": {
"description": "Distinguishes the type of involvement of the actor in the activities related to the family member history.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"actor": {
"description": "Indicates who or what participated in the activities related to the family member history.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"actor"
]
},
"FamilyMemberHistory_Condition": {
"description": "Significant health conditions for a person related to the patient relevant in the context of care for the patient.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like \u0027cancer\u0027 depending on how much is known about the condition and the capabilities of the creating system.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"outcome": {
"description": "Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"contributedToDeath": {
"description": "This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.",
"$ref": "#/definitions/boolean"
},
"_contributedToDeath": {
"description": "Extensions for contributedToDeath",
"$ref": "Element.schema.json#/definitions/Element"
},
"onsetAge": {
"description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.",
"$ref": "Age.schema.json#/definitions/Age"
},
"onsetRange": {
"description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.",
"$ref": "Range.schema.json#/definitions/Range"
},
"onsetPeriod": {
"description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.",
"$ref": "Period.schema.json#/definitions/Period"
},
"onsetString": {
"description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_onsetString": {
"description": "Extensions for onsetString",
"$ref": "Element.schema.json#/definitions/Element"
},
"note": {
"description": "An area where general notes can be placed about this specific condition.",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"code"
]
},
"FamilyMemberHistory_Procedure": {
"description": "Significant health conditions for a person related to the patient relevant in the context of care for the patient.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "The actual procedure specified. Could be a coded procedure or a less specific string depending on how much is known about the procedure and the capabilities of the creating system.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"outcome": {
"description": "Indicates what happened following the procedure. If the procedure resulted in death, deceased date is captured on the relation.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"contributedToDeath": {
"description": "This procedure contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.",
"$ref": "#/definitions/boolean"
},
"_contributedToDeath": {
"description": "Extensions for contributedToDeath",
"$ref": "Element.schema.json#/definitions/Element"
},
"performedAge": {
"description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.",
"$ref": "Age.schema.json#/definitions/Age"
},
"performedRange": {
"description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.",
"$ref": "Range.schema.json#/definitions/Range"
},
"performedPeriod": {
"description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.",
"$ref": "Period.schema.json#/definitions/Period"
},
"performedString": {
"description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_performedString": {
"description": "Extensions for performedString",
"$ref": "Element.schema.json#/definitions/Element"
},
"performedDateTime": {
"description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_performedDateTime": {
"description": "Extensions for performedDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"note": {
"description": "An area where general notes can be placed about this specific procedure.",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"code"
]
}
}
}
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:24+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change