schemas.FamilyMemberHistory.schema.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fhirlib Show documentation
Show all versions of fhirlib Show documentation
A scala ser/de library for working with FHIR data
{
"$schema": "http://json-schema.org/draft-04/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": {
"allOf": [
{
"$ref": "DomainResource#/definitions/DomainResource"
},
{
"description": "Significant health events and 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",
"type": "string",
"enum": [
"FamilyMemberHistory"
]
},
"identifier": {
"description": "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).",
"type": "array",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
}
},
"definition": {
"description": "A protocol or questionnaire that was adhered to in whole or in part by this event.",
"type": "array",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"status": {
"description": "A code specifying the status of the record of the family history of a specific family member.",
"enum": [
"partial",
"completed",
"entered-in-error",
"health-unknown"
],
"type": "string"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"notDone": {
"description": "If true, indicates the taking of an individual family member\u0027s 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.",
"type": "boolean"
},
"_notDone": {
"description": "Extensions for notDone",
"$ref": "Element.schema.json#/definitions/Element"
},
"notDoneReason": {
"description": "Describes why the family member\u0027s history is absent.",
"$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 taken.",
"type": "string",
"pattern": "-?[0-9]{4}(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"name": {
"description": "This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\".",
"type": "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"
},
"gender": {
"description": "Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.",
"enum": [
"male",
"female",
"other",
"unknown"
],
"type": "string"
},
"_gender": {
"description": "Extensions for gender",
"$ref": "Element.schema.json#/definitions/Element"
},
"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]{4}(-(0[1-9]|1[0-2])(-(0[0-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.",
"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.",
"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.",
"type": "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.",
"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]{4}(-(0[1-9]|1[0-2])(-(0[0-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.",
"type": "string"
},
"_deceasedString": {
"description": "Extensions for deceasedString",
"$ref": "Element.schema.json#/definitions/Element"
},
"reasonCode": {
"description": "Describes why the family member history occurred in coded or textual form.",
"type": "array",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"reasonReference": {
"description": "Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.",
"type": "array",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"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.",
"type": "array",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
}
},
"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.",
"type": "array",
"items": {
"$ref": "#/definitions/FamilyMemberHistory_Condition"
}
}
},
"required": [
"patient",
"relationship",
"resourceType"
]
}
]
},
"FamilyMemberHistory_Condition": {
"allOf": [
{
"$ref": "BackboneElement#/definitions/BackboneElement"
},
{
"description": "Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.",
"properties": {
"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 as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"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.",
"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.",
"type": "array",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
}
}
},
"required": [
"code"
]
}
]
}
}
}