Please note:

This version is not suitable for implementation. It's purpose is to provide FHIR assets and guidance in support of Clinical and Technical Assurance Sprint 6. Other versions of the UK Core are available: here
Please follow the guidance in the C&TA Sprint 6 pack to provide feedback.
Please follow the guidance on the Contact Us page if you need any assistance.

StructureDefinition-UKCore-FamilyMemberHistory

Description
This profile defines the UK constraints and extensions on the International FHIR resource FamilyMemberHistory.

ProfilePurpose
This profile allows exchange of information about health events and conditions for a person related to the patient relevant in the context of care.

Profile Purpose

This profile is a record of a task to be performed.

Snapshot View

FamilyMemberHistory	I		FamilyMemberHistory	There are no (further) constraints on this element Element Id FamilyMemberHistory Short description Information about patient's relatives, relevant for patient Definition Significant health conditions for a person related to the patient relevant in the context of care for the patient. Data Type FamilyMemberHistory Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` fhs-2:Can only have estimatedAge if age[x] is present `age.exists() or estimatedAge.empty()` fhs-1:Can have age[x] or born[x], but not both `age.empty() or born.empty()` Mappings rim:Entity. Role, or Act workflow:Event v2:Not in scope for v2 rim:Observation[classCode=OBS, moodCode=EVN]
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier Short description External Id(s) for this record Definition 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. Requirements Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers. Comments This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier workflow:Event.identifier w5:FiveWs.identifier rim:id
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id FamilyMemberHistory.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition \| UK Core Questionnaire \| ActivityDefinition \| Measure \| OperationDefinition)	Element Id FamilyMemberHistory.instantiatesCanonical Short description Instantiates FHIR protocol or definition Definition 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. Comments see Canonical References Data Type canonical(PlanDefinition \| UK Core Questionnaire \| ActivityDefinition \| Measure \| OperationDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Event.instantiatesCanonical rim:.outboundRelationship[typeCode=DEFN].target
instantiatesUri	Σ	0..*	uri	There are no (further) constraints on this element Element Id FamilyMemberHistory.instantiatesUri Short description Instantiates external protocol or definition Definition 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. Comments This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Event.instantiatesUri rim:.outboundRelationship[typeCode=DEFN].target
status	Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element Id FamilyMemberHistory.status Short description 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. Comments This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Data Type code Binding A code that identifies the status of the family history record. FamilyHistoryStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Event.status w5:FiveWs.status
dataAbsentReason	Σ	0..1	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.dataAbsentReason Short description subject-unknown \| withheld \| unable-to-obtain \| deferred Definition Describes why the family member's history is not available. Requirements This is a separate element to allow it to have a distinct binding from reasonCode. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Codes describing the reason why a family member's history is not available. FamilyHistoryAbsentReason (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.reasonCode
patient	Σ I	1..1	Reference(UK Core Patient)	Element Id FamilyMemberHistory.patient Short description Patient history is about Alternate names Proband Definition The person who this history concerns. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(UK Core Patient) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow:Event.subject w5:FiveWs.subject[x] rim:participation[typeCode=SBJ].role w5:FiveWs.subject
date	Σ	0..1	dateTime	There are no (further) constraints on this element Element Id FamilyMemberHistory.date Short description When history was recorded or last updated Definition The date (and possibly time) when the family member history was recorded or last updated. Requirements Allows determination of how current the summary is. Comments This should be captured even if the same as the date on the List aggregating the full family history. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.recorded rim:participation[typeCode=AUT].time
name	Σ	0..1	string	There are no (further) constraints on this element Element Id FamilyMemberHistory.name Short description 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. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:name
relationship	Σ	1..1	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.relationship Short description Relationship to the subject Definition The type of relationship this person has to the patient (father, mother, brother etc.). Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding The nature of the relationship between the patient and the related person being described in the family member history. v3.FamilyMember (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:code
sex	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id FamilyMemberHistory.sex Short description male \| female \| other \| unknown Definition The birth sex of the family member. Requirements Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments. Comments This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element. Data Type CodeableConcept Binding Codes describing the sex assigned at birth as documented on the birth registration. AdministrativeGender (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
born[x]	I	0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.born[x] Short description (approximate) date of birth Definition The actual or approximate date of birth of the relative. Requirements Allows calculation of the relative's age. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)
bornPeriod			Period	There are no (further) constraints on this element Data Type Period
bornDate			date	There are no (further) constraints on this element Data Type date
bornString			string	There are no (further) constraints on this element Data Type string
age[x]	Σ I	0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.age[x] Short description (approximate) age Definition The age of the relative at the time the family member history is recorded. Requirements While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians. Comments use estimatedAge to indicate whether the age is actual or not. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code="age"].value
ageAge			Age	There are no (further) constraints on this element Data Type Age
ageRange			Range	There are no (further) constraints on this element Data Type Range
ageString			string	There are no (further) constraints on this element Data Type string
estimatedAge	Σ I	0..1	boolean	There are no (further) constraints on this element Element Id FamilyMemberHistory.estimatedAge Short description Age is estimated? Definition If true, indicates that the age value specified is an estimated value. Requirements Clinicians often prefer to specify an estimaged age rather than an age range. Comments This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
deceased[x]	Σ	0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.deceased[x] Short description 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. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role
deceasedBoolean			boolean	There are no (further) constraints on this element Data Type boolean
deceasedAge			Age	There are no (further) constraints on this element Data Type Age
deceasedRange			Range	There are no (further) constraints on this element Data Type Range
deceasedDate			date	There are no (further) constraints on this element Data Type date
deceasedString			string	There are no (further) constraints on this element Data Type string
reasonCode	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.reasonCode Short description Why was family member history performed? Definition Describes why the family member history occurred in coded or textual form. Comments Textual reasons can be captured using reasonCode.text. Data Type CodeableConcept Binding Codes indicating why the family member history was done. SNOMEDCTClinicalFindings (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD workflow:Event.reasonCode w5:FiveWs.why[x] rim:.reasonCode
reasonReference	Σ I	0..*	Reference(UK Core Condition \| UK Core Observation \| UK Core AllergyIntolerance \| UK Core QuestionnaireResponse \| UK Core DiagnosticReport \| UK Core DocumentReference)	Element Id FamilyMemberHistory.reasonReference Short description Why was family member history performed? Definition Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(UK Core Condition \| UK Core Observation \| UK Core AllergyIntolerance \| UK Core QuestionnaireResponse \| UK Core DiagnosticReport \| UK Core DocumentReference) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow:Event.reasonReference w5:FiveWs.why[x] rim:.outboundRelationship[typeCode=RSON].target
note		0..*	Annotation	There are no (further) constraints on this element Element Id FamilyMemberHistory.note Short description 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. Comments For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). Data Type Annotation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act workflow:Event.note rim:inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value
author[x]	Σ	0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.note.author[x] Short description Individual responsible for the annotation Definition The individual responsible for making the annotation. Comments Organization is used when there's no need for specific attribution as to who made the comment. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act.participant[typeCode=AUT].role
authorString			string	Data Type string
authorReference			Reference(UK Core Practitioner \| UK Core Patient \| UK Core RelatedPerson \| UK Core Organization)	Data Type Reference(UK Core Practitioner \| UK Core Patient \| UK Core RelatedPerson \| UK Core Organization)
time	Σ	0..1	dateTime	There are no (further) constraints on this element Element Id FamilyMemberHistory.note.time Short description When the annotation was made Definition Indicates when this particular annotation was made. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act.effectiveTime
text	Σ	1..1	markdown	There are no (further) constraints on this element Element Id FamilyMemberHistory.note.text Short description The annotation - text content (as markdown) Definition The text of the annotation in markdown format. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act.text
condition		0..*	BackboneElement	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition Short description 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. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]
code		1..1	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.code Short description 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. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Identification of the Condition or diagnosis. Condition/Problem/DiagnosisCodes (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.value
outcome		0..1	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.outcome Short description deceased \| permanent disability \| etc. Definition Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. ConditionOutcomeCodes (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value
contributedToDeath		0..1	boolean	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.contributedToDeath Short description Whether the condition contributed to the cause of death Definition This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
onset[x]		0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.onset[x] Short description 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. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim: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
onsetAge			Age	There are no (further) constraints on this element Data Type Age
onsetRange			Range	There are no (further) constraints on this element Data Type Range
onsetPeriod			Period	There are no (further) constraints on this element Data Type Period
onsetString			string	There are no (further) constraints on this element Data Type string
note		0..*	Annotation	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.note Short description Extra information about condition Definition An area where general notes can be placed about this specific condition. Comments For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). Data Type Annotation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act rim:inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value

Differential View

FamilyMemberHistory	I		FamilyMemberHistory	There are no (further) constraints on this element Element Id FamilyMemberHistory Short description Information about patient's relatives, relevant for patient Definition Significant health conditions for a person related to the patient relevant in the context of care for the patient. Data Type FamilyMemberHistory Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` fhs-2:Can only have estimatedAge if age[x] is present `age.exists() or estimatedAge.empty()` fhs-1:Can have age[x] or born[x], but not both `age.empty() or born.empty()` Mappings rim:Entity. Role, or Act workflow:Event v2:Not in scope for v2 rim:Observation[classCode=OBS, moodCode=EVN]
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier Short description External Id(s) for this record Definition 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. Requirements Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers. Comments This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier workflow:Event.identifier w5:FiveWs.identifier rim:id
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id FamilyMemberHistory.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition \| UK Core Questionnaire \| ActivityDefinition \| Measure \| OperationDefinition)	Element Id FamilyMemberHistory.instantiatesCanonical Short description Instantiates FHIR protocol or definition Definition 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. Comments see Canonical References Data Type canonical(PlanDefinition \| UK Core Questionnaire \| ActivityDefinition \| Measure \| OperationDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Event.instantiatesCanonical rim:.outboundRelationship[typeCode=DEFN].target
instantiatesUri	Σ	0..*	uri	There are no (further) constraints on this element Element Id FamilyMemberHistory.instantiatesUri Short description Instantiates external protocol or definition Definition 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. Comments This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Event.instantiatesUri rim:.outboundRelationship[typeCode=DEFN].target
status	Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element Id FamilyMemberHistory.status Short description 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. Comments This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Data Type code Binding A code that identifies the status of the family history record. FamilyHistoryStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Event.status w5:FiveWs.status
dataAbsentReason	Σ	0..1	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.dataAbsentReason Short description subject-unknown \| withheld \| unable-to-obtain \| deferred Definition Describes why the family member's history is not available. Requirements This is a separate element to allow it to have a distinct binding from reasonCode. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Codes describing the reason why a family member's history is not available. FamilyHistoryAbsentReason (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.reasonCode
patient	Σ I	1..1	Reference(UK Core Patient)	Element Id FamilyMemberHistory.patient Short description Patient history is about Alternate names Proband Definition The person who this history concerns. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(UK Core Patient) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow:Event.subject w5:FiveWs.subject[x] rim:participation[typeCode=SBJ].role w5:FiveWs.subject
date	Σ	0..1	dateTime	There are no (further) constraints on this element Element Id FamilyMemberHistory.date Short description When history was recorded or last updated Definition The date (and possibly time) when the family member history was recorded or last updated. Requirements Allows determination of how current the summary is. Comments This should be captured even if the same as the date on the List aggregating the full family history. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.recorded rim:participation[typeCode=AUT].time
name	Σ	0..1	string	There are no (further) constraints on this element Element Id FamilyMemberHistory.name Short description 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. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:name
relationship	Σ	1..1	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.relationship Short description Relationship to the subject Definition The type of relationship this person has to the patient (father, mother, brother etc.). Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding The nature of the relationship between the patient and the related person being described in the family member history. v3.FamilyMember (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:code
sex	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id FamilyMemberHistory.sex Short description male \| female \| other \| unknown Definition The birth sex of the family member. Requirements Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments. Comments This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element. Data Type CodeableConcept Binding Codes describing the sex assigned at birth as documented on the birth registration. AdministrativeGender (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
born[x]	I	0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.born[x] Short description (approximate) date of birth Definition The actual or approximate date of birth of the relative. Requirements Allows calculation of the relative's age. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)
bornPeriod			Period	There are no (further) constraints on this element Data Type Period
bornDate			date	There are no (further) constraints on this element Data Type date
bornString			string	There are no (further) constraints on this element Data Type string
age[x]	Σ I	0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.age[x] Short description (approximate) age Definition The age of the relative at the time the family member history is recorded. Requirements While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians. Comments use estimatedAge to indicate whether the age is actual or not. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code="age"].value
ageAge			Age	There are no (further) constraints on this element Data Type Age
ageRange			Range	There are no (further) constraints on this element Data Type Range
ageString			string	There are no (further) constraints on this element Data Type string
estimatedAge	Σ I	0..1	boolean	There are no (further) constraints on this element Element Id FamilyMemberHistory.estimatedAge Short description Age is estimated? Definition If true, indicates that the age value specified is an estimated value. Requirements Clinicians often prefer to specify an estimaged age rather than an age range. Comments This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
deceased[x]	Σ	0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.deceased[x] Short description 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. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role
deceasedBoolean			boolean	There are no (further) constraints on this element Data Type boolean
deceasedAge			Age	There are no (further) constraints on this element Data Type Age
deceasedRange			Range	There are no (further) constraints on this element Data Type Range
deceasedDate			date	There are no (further) constraints on this element Data Type date
deceasedString			string	There are no (further) constraints on this element Data Type string
reasonCode	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.reasonCode Short description Why was family member history performed? Definition Describes why the family member history occurred in coded or textual form. Comments Textual reasons can be captured using reasonCode.text. Data Type CodeableConcept Binding Codes indicating why the family member history was done. SNOMEDCTClinicalFindings (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD workflow:Event.reasonCode w5:FiveWs.why[x] rim:.reasonCode
reasonReference	Σ I	0..*	Reference(UK Core Condition \| UK Core Observation \| UK Core AllergyIntolerance \| UK Core QuestionnaireResponse \| UK Core DiagnosticReport \| UK Core DocumentReference)	Element Id FamilyMemberHistory.reasonReference Short description Why was family member history performed? Definition Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(UK Core Condition \| UK Core Observation \| UK Core AllergyIntolerance \| UK Core QuestionnaireResponse \| UK Core DiagnosticReport \| UK Core DocumentReference) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow:Event.reasonReference w5:FiveWs.why[x] rim:.outboundRelationship[typeCode=RSON].target
note		0..*	Annotation	There are no (further) constraints on this element Element Id FamilyMemberHistory.note Short description 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. Comments For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). Data Type Annotation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act workflow:Event.note rim:inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value
author[x]	Σ	0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.note.author[x] Short description Individual responsible for the annotation Definition The individual responsible for making the annotation. Comments Organization is used when there's no need for specific attribution as to who made the comment. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act.participant[typeCode=AUT].role
authorString			string	Data Type string
authorReference			Reference(UK Core Practitioner \| UK Core Patient \| UK Core RelatedPerson \| UK Core Organization)	Data Type Reference(UK Core Practitioner \| UK Core Patient \| UK Core RelatedPerson \| UK Core Organization)
time	Σ	0..1	dateTime	There are no (further) constraints on this element Element Id FamilyMemberHistory.note.time Short description When the annotation was made Definition Indicates when this particular annotation was made. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act.effectiveTime
text	Σ	1..1	markdown	There are no (further) constraints on this element Element Id FamilyMemberHistory.note.text Short description The annotation - text content (as markdown) Definition The text of the annotation in markdown format. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act.text
condition		0..*	BackboneElement	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition Short description 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. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]
code		1..1	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.code Short description 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. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Identification of the Condition or diagnosis. Condition/Problem/DiagnosisCodes (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.value
outcome		0..1	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.outcome Short description deceased \| permanent disability \| etc. Definition Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. ConditionOutcomeCodes (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value
contributedToDeath		0..1	boolean	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.contributedToDeath Short description Whether the condition contributed to the cause of death Definition This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
onset[x]		0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.onset[x] Short description 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. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim: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
onsetAge			Age	There are no (further) constraints on this element Data Type Age
onsetRange			Range	There are no (further) constraints on this element Data Type Range
onsetPeriod			Period	There are no (further) constraints on this element Data Type Period
onsetString			string	There are no (further) constraints on this element Data Type string
note		0..*	Annotation	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.note Short description Extra information about condition Definition An area where general notes can be placed about this specific condition. Comments For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). Data Type Annotation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act rim:inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value

Hybrid View

FamilyMemberHistory	I		FamilyMemberHistory	There are no (further) constraints on this element Element Id FamilyMemberHistory Short description Information about patient's relatives, relevant for patient Definition Significant health conditions for a person related to the patient relevant in the context of care for the patient. Data Type FamilyMemberHistory Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` fhs-2:Can only have estimatedAge if age[x] is present `age.exists() or estimatedAge.empty()` fhs-1:Can have age[x] or born[x], but not both `age.empty() or born.empty()` Mappings rim:Entity. Role, or Act workflow:Event v2:Not in scope for v2 rim:Observation[classCode=OBS, moodCode=EVN]
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier Short description External Id(s) for this record Definition 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. Requirements Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers. Comments This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier workflow:Event.identifier w5:FiveWs.identifier rim:id
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id FamilyMemberHistory.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id FamilyMemberHistory.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition \| UK Core Questionnaire \| ActivityDefinition \| Measure \| OperationDefinition)	Element Id FamilyMemberHistory.instantiatesCanonical Short description Instantiates FHIR protocol or definition Definition 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. Comments see Canonical References Data Type canonical(PlanDefinition \| UK Core Questionnaire \| ActivityDefinition \| Measure \| OperationDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Event.instantiatesCanonical rim:.outboundRelationship[typeCode=DEFN].target
instantiatesUri	Σ	0..*	uri	There are no (further) constraints on this element Element Id FamilyMemberHistory.instantiatesUri Short description Instantiates external protocol or definition Definition 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. Comments This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Event.instantiatesUri rim:.outboundRelationship[typeCode=DEFN].target
status	Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element Id FamilyMemberHistory.status Short description 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. Comments This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Data Type code Binding A code that identifies the status of the family history record. FamilyHistoryStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Event.status w5:FiveWs.status
dataAbsentReason	Σ	0..1	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.dataAbsentReason Short description subject-unknown \| withheld \| unable-to-obtain \| deferred Definition Describes why the family member's history is not available. Requirements This is a separate element to allow it to have a distinct binding from reasonCode. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Codes describing the reason why a family member's history is not available. FamilyHistoryAbsentReason (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.reasonCode
patient	Σ I	1..1	Reference(UK Core Patient)	Element Id FamilyMemberHistory.patient Short description Patient history is about Alternate names Proband Definition The person who this history concerns. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(UK Core Patient) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow:Event.subject w5:FiveWs.subject[x] rim:participation[typeCode=SBJ].role w5:FiveWs.subject
date	Σ	0..1	dateTime	There are no (further) constraints on this element Element Id FamilyMemberHistory.date Short description When history was recorded or last updated Definition The date (and possibly time) when the family member history was recorded or last updated. Requirements Allows determination of how current the summary is. Comments This should be captured even if the same as the date on the List aggregating the full family history. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.recorded rim:participation[typeCode=AUT].time
name	Σ	0..1	string	There are no (further) constraints on this element Element Id FamilyMemberHistory.name Short description 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. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:name
relationship	Σ	1..1	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.relationship Short description Relationship to the subject Definition The type of relationship this person has to the patient (father, mother, brother etc.). Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding The nature of the relationship between the patient and the related person being described in the family member history. v3.FamilyMember (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:code
sex	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id FamilyMemberHistory.sex Short description male \| female \| other \| unknown Definition The birth sex of the family member. Requirements Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments. Comments This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element. Data Type CodeableConcept Binding Codes describing the sex assigned at birth as documented on the birth registration. AdministrativeGender (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
born[x]	I	0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.born[x] Short description (approximate) date of birth Definition The actual or approximate date of birth of the relative. Requirements Allows calculation of the relative's age. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)
bornPeriod			Period	There are no (further) constraints on this element Data Type Period
bornDate			date	There are no (further) constraints on this element Data Type date
bornString			string	There are no (further) constraints on this element Data Type string
age[x]	Σ I	0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.age[x] Short description (approximate) age Definition The age of the relative at the time the family member history is recorded. Requirements While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians. Comments use estimatedAge to indicate whether the age is actual or not. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code="age"].value
ageAge			Age	There are no (further) constraints on this element Data Type Age
ageRange			Range	There are no (further) constraints on this element Data Type Range
ageString			string	There are no (further) constraints on this element Data Type string
estimatedAge	Σ I	0..1	boolean	There are no (further) constraints on this element Element Id FamilyMemberHistory.estimatedAge Short description Age is estimated? Definition If true, indicates that the age value specified is an estimated value. Requirements Clinicians often prefer to specify an estimaged age rather than an age range. Comments This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
deceased[x]	Σ	0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.deceased[x] Short description 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. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role
deceasedBoolean			boolean	There are no (further) constraints on this element Data Type boolean
deceasedAge			Age	There are no (further) constraints on this element Data Type Age
deceasedRange			Range	There are no (further) constraints on this element Data Type Range
deceasedDate			date	There are no (further) constraints on this element Data Type date
deceasedString			string	There are no (further) constraints on this element Data Type string
reasonCode	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.reasonCode Short description Why was family member history performed? Definition Describes why the family member history occurred in coded or textual form. Comments Textual reasons can be captured using reasonCode.text. Data Type CodeableConcept Binding Codes indicating why the family member history was done. SNOMEDCTClinicalFindings (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD workflow:Event.reasonCode w5:FiveWs.why[x] rim:.reasonCode
reasonReference	Σ I	0..*	Reference(UK Core Condition \| UK Core Observation \| UK Core AllergyIntolerance \| UK Core QuestionnaireResponse \| UK Core DiagnosticReport \| UK Core DocumentReference)	Element Id FamilyMemberHistory.reasonReference Short description Why was family member history performed? Definition Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(UK Core Condition \| UK Core Observation \| UK Core AllergyIntolerance \| UK Core QuestionnaireResponse \| UK Core DiagnosticReport \| UK Core DocumentReference) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow:Event.reasonReference w5:FiveWs.why[x] rim:.outboundRelationship[typeCode=RSON].target
note		0..*	Annotation	There are no (further) constraints on this element Element Id FamilyMemberHistory.note Short description 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. Comments For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). Data Type Annotation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act workflow:Event.note rim:inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value
author[x]	Σ	0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.note.author[x] Short description Individual responsible for the annotation Definition The individual responsible for making the annotation. Comments Organization is used when there's no need for specific attribution as to who made the comment. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act.participant[typeCode=AUT].role
authorString			string	Data Type string
authorReference			Reference(UK Core Practitioner \| UK Core Patient \| UK Core RelatedPerson \| UK Core Organization)	Data Type Reference(UK Core Practitioner \| UK Core Patient \| UK Core RelatedPerson \| UK Core Organization)
time	Σ	0..1	dateTime	There are no (further) constraints on this element Element Id FamilyMemberHistory.note.time Short description When the annotation was made Definition Indicates when this particular annotation was made. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act.effectiveTime
text	Σ	1..1	markdown	There are no (further) constraints on this element Element Id FamilyMemberHistory.note.text Short description The annotation - text content (as markdown) Definition The text of the annotation in markdown format. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act.text
condition		0..*	BackboneElement	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition Short description 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. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]
code		1..1	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.code Short description 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. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Identification of the Condition or diagnosis. Condition/Problem/DiagnosisCodes (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.value
outcome		0..1	CodeableConcept	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.outcome Short description deceased \| permanent disability \| etc. Definition Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. ConditionOutcomeCodes (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value
contributedToDeath		0..1	boolean	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.contributedToDeath Short description Whether the condition contributed to the cause of death Definition This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
onset[x]		0..1		There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.onset[x] Short description 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. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim: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
onsetAge			Age	There are no (further) constraints on this element Data Type Age
onsetRange			Range	There are no (further) constraints on this element Data Type Range
onsetPeriod			Period	There are no (further) constraints on this element Data Type Period
onsetString			string	There are no (further) constraints on this element Data Type string
note		0..*	Annotation	There are no (further) constraints on this element Element Id FamilyMemberHistory.condition.note Short description Extra information about condition Definition An area where general notes can be placed about this specific condition. Comments For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). Data Type Annotation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Act rim:inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value

Table View

FamilyMemberHistory		..
FamilyMemberHistory.identifier		..
FamilyMemberHistory.identifier.assigner	Reference(UK Core Organization)	..
FamilyMemberHistory.instantiatesCanonical	canonical(PlanDefinition \| UK Core Questionnaire \| ActivityDefinition \| Measure \| OperationDefinition)	..
FamilyMemberHistory.patient	Reference(UK Core Patient)	..
FamilyMemberHistory.reasonReference	Reference(UK Core Condition \| UK Core Observation \| UK Core AllergyIntolerance \| UK Core QuestionnaireResponse \| UK Core DiagnosticReport \| UK Core DocumentReference)	..
FamilyMemberHistory.note		..
FamilyMemberHistory.note.author[x]	Reference(UK Core Practitioner \| UK Core Patient \| UK Core RelatedPerson \| UK Core Organization), string	..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-FamilyMemberHistory" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-FamilyMemberHistory" />
    <version value="1.0.0" />
    <name value="UKCoreFamilyMemberHistory" />
    <title value="UKCore FamilyMemberHistory" />
    <status value="draft" />
    <date value="2022-12-16" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [FamilyMemberHistory](https://hl7.org/fhir/R4/familymemberhistory.html)." />
    <purpose value="This profile allows exchange of information about health events and conditions for a person related to the patient relevant in the context of care." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="FamilyMemberHistory" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory" />
    <derivation value="constraint" />
    <differential>
        <element id="FamilyMemberHistory.identifier.assigner">
            <path value="FamilyMemberHistory.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="FamilyMemberHistory.instantiatesCanonical">
            <path value="FamilyMemberHistory.instantiatesCanonical" />
            <type>
                <code value="canonical" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/PlanDefinition" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/ActivityDefinition" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Measure" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/OperationDefinition" />
            </type>
        </element>
        <element id="FamilyMemberHistory.patient">
            <path value="FamilyMemberHistory.patient" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
            </type>
        </element>
        <element id="FamilyMemberHistory.reasonReference">
            <path value="FamilyMemberHistory.reasonReference" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference" />
            </type>
        </element>
        <element id="FamilyMemberHistory.note.author[x]">
            <path value="FamilyMemberHistory.note.author[x]" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
            <type>
                <code value="string" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-FamilyMemberHistory",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-FamilyMemberHistory",
    "version": "1.0.0",
    "name": "UKCoreFamilyMemberHistory",
    "title": "UKCore FamilyMemberHistory",
    "status": "draft",
    "date": "2022-12-16",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [FamilyMemberHistory](https://hl7.org/fhir/R4/familymemberhistory.html).",
    "purpose": "This profile allows exchange of information about health events and conditions for a person related to the patient relevant in the context of care.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "FamilyMemberHistory",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "FamilyMemberHistory.identifier.assigner",
                "path": "FamilyMemberHistory.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "FamilyMemberHistory.instantiatesCanonical",
                "path": "FamilyMemberHistory.instantiatesCanonical",
                "type":  [
                    {
                        "code": "canonical",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire",
                            "http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
                            "http://hl7.org/fhir/StructureDefinition/Measure",
                            "http://hl7.org/fhir/StructureDefinition/OperationDefinition"
                        ]
                    }
                ]
            },
            {
                "id": "FamilyMemberHistory.patient",
                "path": "FamilyMemberHistory.patient",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"
                        ]
                    }
                ]
            },
            {
                "id": "FamilyMemberHistory.reasonReference",
                "path": "FamilyMemberHistory.reasonReference",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference"
                        ]
                    }
                ]
            },
            {
                "id": "FamilyMemberHistory.note.author[x]",
                "path": "FamilyMemberHistory.note.author[x]",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    },
                    {
                        "code": "string"
                    }
                ]
            }
        ]
    }
}

Examples

Father with Diabetes - An example to illustrate the the use of FamilyMemberHistory to record a father with diabetes.
Example UKCore-FamilyMemberHistory-FatherDiabetes

Example Usage Scenarios

The following are example usage scenarios for the UK Core FamilyMemberHistory profile:

Query for details of a FamilyMemberHistory
Exchange FamilyMemberHistory information within a FHIR document or message.

Profile Specific Implementation Guidance:

Extensions

NOTE: The following extensions have been suggested for use in the UKCore-FamilyMemberHistory profile, and are to be discussed during Clinical and Technical Assurance sprint 6.

More information about the extensions can be found using the links below.

Extension	Context	Link	Comment
Recorder	FamilyMemberHistory	Extension UKCore-Recorder	An extension to reference a practitioner that recorded an event.
AssociatedEncounter	FamilyMemberHistory	Extension UKCore-AssociatedEncounter	This extension is used to reference an associated encounter.

`instantiatesCanonical`

The resource being referenced SHOULD conform to the following:

`patient`

The resource being referenced SHOULD conform to the Profile UKCore-Patient.

`reasonReference`

The resource being referenced SHOULD conform to the following:

`note`

The resource being referenced by FamilyMemberHistory.note.authorReference SHOULD conform to one of the following: