FHIR Release 3 (STU)
Clinical SummaryThis page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
| Patient Care Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Patient |
StructureDefinition for familymemberhistory
{
"resourceType": "StructureDefinition",
"id": "FamilyMemberHistory",
"meta": {
"lastUpdated": "2019-10-24T11:53:00+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pc"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory",
"name": "FamilyMemberHistory",
"status": "draft",
"date": "2019-10-24T11:53:00+11:00",
"publisher": "Health Level Seven International (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for FamilyMemberHistory Resource",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "FamilyMemberHistory",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "FamilyMemberHistory",
"path": "FamilyMemberHistory",
"short": "Information about patient's relatives, relevant for patient",
"definition": "Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
},
{
"key": "fhs-2",
"severity": "error",
"human": "Can only have estimatedAge if age[x] is present",
"expression": "age.exists() or estimatedAge.empty()",
"xpath": "exists(*[starts-with(local-name(.), 'age')]) or not(exists(f:estimatedAge))"
},
{
"key": "fhs-3",
"severity": "error",
"human": "Not Done Reason can only be specified if NotDone is \"true\"",
"expression": "notDone or notDoneReason.exists().not()",
"xpath": "f:notDone/@value=true() or not(exists(f:notDoneReason))"
},
{
"key": "fhs-1",
"severity": "error",
"human": "Can have age[x] or born[x], but not both",
"expression": "age.empty() or born.empty()",
"xpath": "not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "v2",
"map": "Not in scope for v2"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
},
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"id": "FamilyMemberHistory.id",
"path": "FamilyMemberHistory.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "FamilyMemberHistory.meta",
"path": "FamilyMemberHistory.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "FamilyMemberHistory.implicitRules",
"path": "FamilyMemberHistory.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "FamilyMemberHistory.language",
"path": "FamilyMemberHistory.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "FamilyMemberHistory.text",
"path": "FamilyMemberHistory.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "FamilyMemberHistory.contained",
"path": "FamilyMemberHistory.contained",
"short": "Contained, inline Resources",
"definition": "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.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension",
"path": "FamilyMemberHistory.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.modifierExtension",
"path": "FamilyMemberHistory.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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. Usually modifier elements provide negation or qualification. In order 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.identifier",
"path": "FamilyMemberHistory.identifier",
"short": "External Id(s) for this record",
"definition": "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).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "FamilyMemberHistory.definition",
"path": "FamilyMemberHistory.definition",
"short": "Instantiates protocol or definition",
"definition": "A protocol or questionnaire that was adhered to in whole or in part by this event.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Questionnaire"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target"
}
]
},
{
"id": "FamilyMemberHistory.status",
"path": "FamilyMemberHistory.status",
"short": "partial | completed | entered-in-error | health-unknown",
"definition": "A code specifying the status of the record of the family history of a specific family member.",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilyHistoryStatus"
}
],
"strength": "required",
"description": "A code that identifies the status of the family history record.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/history-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "FamilyMemberHistory.notDone",
"path": "FamilyMemberHistory.notDone",
"short": "The taking of a family member's history did not occur",
"definition": "If 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.",
"comment": "This element is labeled as a modifier because it marks the family member history as a family member history that did not occur. The more attributes are populated, the more constrained the negated statement is. This notDone element is being evaluated and will likely be removed in a subsequent release.",
"requirements": "Creating a FamilyMemberHistory where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".actionNegationInd"
}
]
},
{
"id": "FamilyMemberHistory.notDoneReason",
"path": "FamilyMemberHistory.notDoneReason",
"short": "subject-unknown | withheld | unable-to-obtain | deferred",
"definition": "Describes why the family member's history is absent.",
"comment": "This notDoneReason element is being evaluated and will likely be replaced in a subsequent release (e.g. dataAbsentReason).",
"requirements": "This is a separate element to allow it to have a distinct binding from reasonCode.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"fhs-3"
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilyHistoryNotDoneReason"
}
],
"strength": "example",
"description": "Codes describing the reason why a family member history was not done.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/history-not-done-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "FamilyMemberHistory.patient",
"path": "FamilyMemberHistory.patient",
"short": "Patient history is about",
"definition": "The person who this history concerns.",
"alias": [
"Proband"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ].role"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "FamilyMemberHistory.date",
"path": "FamilyMemberHistory.date",
"short": "When history was captured/updated",
"definition": "The date (and possibly time) when the family member history was taken.",
"comment": "This should be captured even if the same as the date on the List aggregating the full family history.",
"requirements": "Allows determination of how current the summary is.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=AUT].time"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "FamilyMemberHistory.name",
"path": "FamilyMemberHistory.name",
"short": "The family member described",
"definition": "This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\".",
"requirements": "Allows greater ease in ensuring the same person is being talked about.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "name"
}
]
},
{
"id": "FamilyMemberHistory.relationship",
"path": "FamilyMemberHistory.relationship",
"short": "Relationship to the subject",
"definition": "The type of relationship this person has to the patient (father, mother, brother etc.).",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilialRelationship"
}
],
"strength": "example",
"description": "The nature of the relationship between the patient and the related person being described in the family member history.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-FamilyMember"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
}
]
},
{
"id": "FamilyMemberHistory.gender",
"path": "FamilyMemberHistory.gender",
"short": "male | female | other | unknown",
"definition": "Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.",
"requirements": "Not all relationship codes imply gender and the relative's gender can be relevant for risk assessments.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AdministrativeGender"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The gender of a person used for administrative purposes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
}
},
{
"id": "FamilyMemberHistory.born[x]",
"path": "FamilyMemberHistory.born[x]",
"short": "(approximate) date of birth",
"definition": "The actual or approximate date of birth of the relative.",
"requirements": "Allows calculation of the relative's age.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
},
{
"code": "date"
},
{
"code": "string"
}
],
"condition": [
"fhs-1"
],
"mapping": [
{
"identity": "rim",
"map": "player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)"
}
]
},
{
"id": "FamilyMemberHistory.age[x]",
"path": "FamilyMemberHistory.age[x]",
"short": "(approximate) age",
"definition": "The age of the relative at the time the family member history is recorded.",
"comment": "use estimatedAge to indicate whether the age is actual or not.",
"requirements": "While age can be calculated from date of birth, sometimes recording age directly is more natureal for clinicians.",
"min": 0,
"max": "1",
"type": [
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "string"
}
],
"condition": [
"fhs-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code=\"age\"].value"
}
]
},
{
"id": "FamilyMemberHistory.estimatedAge",
"path": "FamilyMemberHistory.estimatedAge",
"short": "Age is estimated?",
"definition": "If true, indicates that the age value specified is an estimated value.",
"comment": "This element is labeled as a modifier because the fact tha age is estimated can/should change the results of any algorithm that calculates based on the specified age.",
"requirements": "Clinicians often prefer to specify an estimaged age rather than an age range.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"meaningWhenMissing": "It is unknown whether the age is an estimate or not",
"condition": [
"fhs-2"
],
"isModifier": true,
"isSummary": true
},
{
"id": "FamilyMemberHistory.deceased[x]",
"path": "FamilyMemberHistory.deceased[x]",
"short": "Dead? How old/when?",
"definition": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "date"
},
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role"
}
]
},
{
"id": "FamilyMemberHistory.reasonCode",
"path": "FamilyMemberHistory.reasonCode",
"short": "Why was family member history performed?",
"definition": "Describes why the family member history occurred in coded or textual form.",
"comment": "Textual reasons can be caprued using reasonCode.text.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilyHistoryReason"
}
],
"strength": "example",
"description": "Codes indicating why the family member history was done.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/clinical-findings"
}
},
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "FamilyMemberHistory.reasonReference",
"path": "FamilyMemberHistory.reasonReference",
"short": "Why was family member history performed?",
"definition": "Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "FamilyMemberHistory.note",
"path": "FamilyMemberHistory.note",
"short": "General note about related person",
"definition": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
},
{
"id": "FamilyMemberHistory.condition",
"path": "FamilyMemberHistory.condition",
"short": "Condition that the related person had",
"definition": "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.",
"comment": "If none of the conditions listed have an outcome of \"death\" specified, that indicates that none of the specified conditions are known to have been the primary cause of death.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]"
}
]
},
{
"id": "FamilyMemberHistory.condition.id",
"path": "FamilyMemberHistory.condition.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.condition.extension",
"path": "FamilyMemberHistory.condition.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.condition.modifierExtension",
"path": "FamilyMemberHistory.condition.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.condition.code",
"path": "FamilyMemberHistory.condition.code",
"short": "Condition suffered by relation",
"definition": "The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConditionCode"
}
],
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/condition-code"
}
},
"mapping": [
{
"identity": "rim",
"map": ".value"
}
]
},
{
"id": "FamilyMemberHistory.condition.outcome",
"path": "FamilyMemberHistory.condition.outcome",
"short": "deceased | permanent disability | etc.",
"definition": "Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConditionOutcome"
}
],
"strength": "example",
"description": "The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/condition-outcome"
}
},
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value"
}
]
},
{
"id": "FamilyMemberHistory.condition.onset[x]",
"path": "FamilyMemberHistory.condition.onset[x]",
"short": "When condition first manifested",
"definition": "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.",
"requirements": "Age of onset of a condition in relatives is predictive of risk for the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "Period"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"Subject Age at measurement\", value<Diagnosis].value[@xsi:typeCode='TS' or 'IVL_TS'] Use originalText for string"
}
]
},
{
"id": "FamilyMemberHistory.condition.note",
"path": "FamilyMemberHistory.condition.note",
"short": "Extra information about condition",
"definition": "An area where general notes can be placed about this specific condition.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
}
]
},
"differential": {
"element": [
{
"id": "FamilyMemberHistory",
"path": "FamilyMemberHistory",
"short": "Information about patient's relatives, relevant for patient",
"definition": "Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "fhs-2",
"severity": "error",
"human": "Can only have estimatedAge if age[x] is present",
"expression": "age.exists() or estimatedAge.empty()",
"xpath": "exists(*[starts-with(local-name(.), 'age')]) or not(exists(f:estimatedAge))"
},
{
"key": "fhs-3",
"severity": "error",
"human": "Not Done Reason can only be specified if NotDone is \"true\"",
"expression": "notDone or notDoneReason.exists().not()",
"xpath": "f:notDone/@value=true() or not(exists(f:notDoneReason))"
},
{
"key": "fhs-1",
"severity": "error",
"human": "Can have age[x] or born[x], but not both",
"expression": "age.empty() or born.empty()",
"xpath": "not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])"
}
],
"mapping": [
{
"identity": "v2",
"map": "Not in scope for v2"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
},
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"id": "FamilyMemberHistory.identifier",
"path": "FamilyMemberHistory.identifier",
"short": "External Id(s) for this record",
"definition": "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).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "FamilyMemberHistory.definition",
"path": "FamilyMemberHistory.definition",
"short": "Instantiates protocol or definition",
"definition": "A protocol or questionnaire that was adhered to in whole or in part by this event.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Questionnaire"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target"
}
]
},
{
"id": "FamilyMemberHistory.status",
"path": "FamilyMemberHistory.status",
"short": "partial | completed | entered-in-error | health-unknown",
"definition": "A code specifying the status of the record of the family history of a specific family member.",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilyHistoryStatus"
}
],
"strength": "required",
"description": "A code that identifies the status of the family history record.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/history-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "FamilyMemberHistory.notDone",
"path": "FamilyMemberHistory.notDone",
"short": "The taking of a family member's history did not occur",
"definition": "If 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.",
"comment": "This element is labeled as a modifier because it marks the family member history as a family member history that did not occur. The more attributes are populated, the more constrained the negated statement is. This notDone element is being evaluated and will likely be removed in a subsequent release.",
"requirements": "Creating a FamilyMemberHistory where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".actionNegationInd"
}
]
},
{
"id": "FamilyMemberHistory.notDoneReason",
"path": "FamilyMemberHistory.notDoneReason",
"short": "subject-unknown | withheld | unable-to-obtain | deferred",
"definition": "Describes why the family member's history is absent.",
"comment": "This notDoneReason element is being evaluated and will likely be replaced in a subsequent release (e.g. dataAbsentReason).",
"requirements": "This is a separate element to allow it to have a distinct binding from reasonCode.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"fhs-3"
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilyHistoryNotDoneReason"
}
],
"strength": "example",
"description": "Codes describing the reason why a family member history was not done.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/history-not-done-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "FamilyMemberHistory.patient",
"path": "FamilyMemberHistory.patient",
"short": "Patient history is about",
"definition": "The person who this history concerns.",
"alias": [
"Proband"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ].role"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "FamilyMemberHistory.date",
"path": "FamilyMemberHistory.date",
"short": "When history was captured/updated",
"definition": "The date (and possibly time) when the family member history was taken.",
"comment": "This should be captured even if the same as the date on the List aggregating the full family history.",
"requirements": "Allows determination of how current the summary is.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=AUT].time"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "FamilyMemberHistory.name",
"path": "FamilyMemberHistory.name",
"short": "The family member described",
"definition": "This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\".",
"requirements": "Allows greater ease in ensuring the same person is being talked about.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "name"
}
]
},
{
"id": "FamilyMemberHistory.relationship",
"path": "FamilyMemberHistory.relationship",
"short": "Relationship to the subject",
"definition": "The type of relationship this person has to the patient (father, mother, brother etc.).",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilialRelationship"
}
],
"strength": "example",
"description": "The nature of the relationship between the patient and the related person being described in the family member history.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-FamilyMember"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
}
]
},
{
"id": "FamilyMemberHistory.gender",
"path": "FamilyMemberHistory.gender",
"short": "male | female | other | unknown",
"definition": "Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.",
"requirements": "Not all relationship codes imply gender and the relative's gender can be relevant for risk assessments.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AdministrativeGender"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The gender of a person used for administrative purposes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
}
},
{
"id": "FamilyMemberHistory.born[x]",
"path": "FamilyMemberHistory.born[x]",
"short": "(approximate) date of birth",
"definition": "The actual or approximate date of birth of the relative.",
"requirements": "Allows calculation of the relative's age.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
},
{
"code": "date"
},
{
"code": "string"
}
],
"condition": [
"fhs-1"
],
"mapping": [
{
"identity": "rim",
"map": "player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)"
}
]
},
{
"id": "FamilyMemberHistory.age[x]",
"path": "FamilyMemberHistory.age[x]",
"short": "(approximate) age",
"definition": "The age of the relative at the time the family member history is recorded.",
"comment": "use estimatedAge to indicate whether the age is actual or not.",
"requirements": "While age can be calculated from date of birth, sometimes recording age directly is more natureal for clinicians.",
"min": 0,
"max": "1",
"type": [
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "string"
}
],
"condition": [
"fhs-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code=\"age\"].value"
}
]
},
{
"id": "FamilyMemberHistory.estimatedAge",
"path": "FamilyMemberHistory.estimatedAge",
"short": "Age is estimated?",
"definition": "If true, indicates that the age value specified is an estimated value.",
"comment": "This element is labeled as a modifier because the fact tha age is estimated can/should change the results of any algorithm that calculates based on the specified age.",
"requirements": "Clinicians often prefer to specify an estimaged age rather than an age range.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"meaningWhenMissing": "It is unknown whether the age is an estimate or not",
"condition": [
"fhs-2"
],
"isModifier": true,
"isSummary": true
},
{
"id": "FamilyMemberHistory.deceased[x]",
"path": "FamilyMemberHistory.deceased[x]",
"short": "Dead? How old/when?",
"definition": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "date"
},
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role"
}
]
},
{
"id": "FamilyMemberHistory.reasonCode",
"path": "FamilyMemberHistory.reasonCode",
"short": "Why was family member history performed?",
"definition": "Describes why the family member history occurred in coded or textual form.",
"comment": "Textual reasons can be caprued using reasonCode.text.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilyHistoryReason"
}
],
"strength": "example",
"description": "Codes indicating why the family member history was done.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/clinical-findings"
}
},
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "FamilyMemberHistory.reasonReference",
"path": "FamilyMemberHistory.reasonReference",
"short": "Why was family member history performed?",
"definition": "Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "FamilyMemberHistory.note",
"path": "FamilyMemberHistory.note",
"short": "General note about related person",
"definition": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
},
{
"id": "FamilyMemberHistory.condition",
"path": "FamilyMemberHistory.condition",
"short": "Condition that the related person had",
"definition": "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.",
"comment": "If none of the conditions listed have an outcome of \"death\" specified, that indicates that none of the specified conditions are known to have been the primary cause of death.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]"
}
]
},
{
"id": "FamilyMemberHistory.condition.code",
"path": "FamilyMemberHistory.condition.code",
"short": "Condition suffered by relation",
"definition": "The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConditionCode"
}
],
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/condition-code"
}
},
"mapping": [
{
"identity": "rim",
"map": ".value"
}
]
},
{
"id": "FamilyMemberHistory.condition.outcome",
"path": "FamilyMemberHistory.condition.outcome",
"short": "deceased | permanent disability | etc.",
"definition": "Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConditionOutcome"
}
],
"strength": "example",
"description": "The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/condition-outcome"
}
},
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value"
}
]
},
{
"id": "FamilyMemberHistory.condition.onset[x]",
"path": "FamilyMemberHistory.condition.onset[x]",
"short": "When condition first manifested",
"definition": "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.",
"requirements": "Age of onset of a condition in relatives is predictive of risk for the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "Period"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"Subject Age at measurement\", value<Diagnosis].value[@xsi:typeCode='TS' or 'IVL_TS'] Use originalText for string"
}
]
},
{
"id": "FamilyMemberHistory.condition.note",
"path": "FamilyMemberHistory.condition.note",
"short": "Extra information about condition",
"definition": "An area where general notes can be placed about this specific condition.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU2 |
|
Propose a change