StructureDefinition NHSEngland-FamilyMemberHistory-Genomics

For collecting relevant Family Member History to aid interpretation of Genomic results. This is limited to collection of Pedigree information. The FamilyMemberHistory resource is not to be used to record participants involved in testing, e.g. in the case of Duo/Trio scenarios (in this case the Genomics-RelatedPerson resource SHOULD be used instead.

The Genomics FamilyMemberHistory is currently pending Clinical and Technical Assurance of the base UKCore resource. Once this profile becomes active in UKCore its suitability for use and need for profiling within Genomics will be assessed.

Profile url FHIR Module Normative Status
https://fhir.nhs.uk/StructureDefinition/NHSEngland-FamilyMemberHistory-Genomics NHS England Genomics trial-use

Canonical_URLStatusCurrent_VersionLast_UpdatedDescription
https://fhir.nhs.uk/StructureDefinition/NHSEngland-FamilyMemberHistory-Genomicsactive0.3.02026-04-16

This profile defines the Genomics constraints and extensions on the UK Core FHIR resource FamilyMemberHistory.


Tree View

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
associatedEncounterC0..1Extension(Reference(Encounter))
id0..1string
id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueCodeableConceptCodeableConcept
id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueReferenceReference(CareTeam | Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
url1..1uriFixed Value
fMHObservationC0..*Extension(Reference(Observation))
modifierExtension?! C0..*Extension
identifierΣ0..1Identifier
instantiatesCanonicalΣ0..*canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)
instantiatesUriΣ0..*uri
statusS Σ ?!1..1codeBinding
dataAbsentReasonΣ0..1CodeableConceptBinding
patientS Σ C1..1Reference(Patient | NHSEngland_Patient_Genomics)
dateS Σ0..1dateTime
nameS Σ0..1string
relationshipS Σ1..1CodeableConceptBinding
sexΣ0..1CodeableConceptBinding
bornDatedate
bornPeriodPeriod
bornStringstring
ageAgeAge
ageRangeRange
ageStringstring
estimatedAgeΣ C0..1boolean
deceasedAgeAge
deceasedBooleanboolean
deceasedDatedate
deceasedRangeRange
deceasedStringstring
reasonCodeΣ0..*CodeableConcept
reasonReferenceΣ C0..*Reference(AllergyIntolerance | Condition | DiagnosticReport | DocumentReference | Observation | QuestionnaireResponse)
note0..*Annotation
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
code1..1CodeableConceptBinding
outcome0..1CodeableConceptBinding
contributedToDeath0..1boolean
onsetAgeAge
onsetPeriodPeriod
onsetRangeRange
onsetStringstring
note0..*Annotation

Detailed Descriptions

FamilyMemberHistory
ShortInformation 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.

Cardinality0..*
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]
FamilyMemberHistory.id
ShortLogical id of this artifact
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality0..1
Typeid
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.meta
ShortMetadata about the resource
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality0..1
TypeMeta
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.implicitRules
ShortA set of rules under which this content was created
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.text
ShortText summary of the resource, for human interpretation
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Cardinality0..1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
FamilyMemberHistory.contained
ShortContained, inline Resources
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Cardinality0..*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
FamilyMemberHistory.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.extension:associatedEncounter
ShortAn associated encounter reference.
Definition

An associated encounter reference.

Cardinality0..1
TypeExtension(Reference(Encounter))
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.extension:participantR5
ShortWho or what participated in the activities related to the family member history. This is a R5 backport.
Definition

An extension to record who or what participated in the activities related to the family member history.

Cardinality0..*
TypeExtension(Complex)
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.extension:participantR5.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
FamilyMemberHistory.extension:participantR5.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality1..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.extension:participantR5.extension:function
ShortThe type of involvement in the activities related to the family member history.
Definition

Distinguishes the type of involvement of the actor in the activities related to the family member history.

Cardinality0..1
TypeExtension
Binding

ParticipationRoleType (extensible)

Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.extension:participantR5.extension:function.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
FamilyMemberHistory.extension:participantR5.extension:function.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.extension:participantR5.extension:function.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value
function
Mappings
  • rim: N/A
FamilyMemberHistory.extension:participantR5.extension:function.value[x]
ShortThe type of involvement in the activities related to the family member history
Definition

This FHIR value set is comprised of Actor participation Type codes, which can be used to value FHIR agents, actors, and other role elements. The codes are intended to express how the agent participated in some activity. Sometimes referred to the agent functional-role relative to the activity.

Cardinality1..1
TypeCodeableConcept
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.extension:participantR5.extension:actor
ShortWho or what participated in the activities related to the family member history.
Definition

Indicates who or what participated in the activities related to the family member history.

Cardinality1..1
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.extension:participantR5.extension:actor.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
FamilyMemberHistory.extension:participantR5.extension:actor.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.extension:participantR5.extension:actor.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value
actor
Mappings
  • rim: N/A
FamilyMemberHistory.extension:participantR5.extension:actor.value[x]
ShortWho or what participated in the activities related to the family member history
Definition

A reference to a Patient, Practitioner, PractitionerRole, RelatedPerson, Device, Organization, or CareTeam.

Cardinality1..1
TypeReference(CareTeam | Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.extension:participantR5.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value
http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant
Mappings
  • rim: N/A
FamilyMemberHistory.extension:participantR5.value[x]
ShortValue of extension
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality0..0
TypeAddress | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.extension:fMHObservation
ShortGenetic markers, ethnicity, etc.
Definition

An extension on the FamilyMemberHistory resource to include Observations relevant to Genomic testing/interpretation.

Cardinality0..*
TypeExtension(Reference(Observation))
Aliasextensions, user content
Comments

This may be extended with additional genomics-specific resources when they are ready.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
  • rim: inboundRelationship[typeCode=SUBJ].source
FamilyMemberHistory.modifierExtension
ShortExtensions that cannot be ignored
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.identifier
ShortExternal Id(s) for this record
Definition

This SHOULD be NHS number or local identifier (if NHS number is unavailable e.g. for non UK residents), though this MAY be omitted if no identifier for the family member is known. If a local identifier is used, an assigner SHALL be provided. The FamilyMemberHistory.identifier field SHALL match the identifier used for a RelatedPerson resource if the same person is being referenced.

Cardinality0..1
TypeIdentifier
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
FamilyMemberHistory.instantiatesCanonical
ShortInstantiates 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.

Cardinality0..*
Typecanonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)
SummaryTrue
Comments
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
FamilyMemberHistory.instantiatesUri
ShortInstantiates 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.

Cardinality0..*
Typeuri
SummaryTrue
Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
FamilyMemberHistory.status
Shortpartial | completed | entered-in-error | health-unknown
Definition

Used to mark the completeness of a given family member's clinical history. If the history of a family member is expected but no history could be obtained, this element SHOULD be filled with 'health-unknown'. Assertions regarding absence of relevant history SHOULD follow guidance within the HL7 FHIR R4 FamilyMemberHistory resource

Cardinality1..1
Typecode
Binding

A code that identifies the status of the family history record.

FamilyHistoryStatus (required)

Must SupportTrue
ModifierTrue
SummaryTrue
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
FamilyMemberHistory.dataAbsentReason
Shortsubject-unknown | withheld | unable-to-obtain | deferred
Definition

Describes why the family member's history is not available.

Cardinality0..1
TypeCodeableConcept
Binding

Codes describing the reason why a family member's history is not available.

FamilyHistoryAbsentReason (extensible)

SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
FamilyMemberHistory.patient
ShortPatient history is about
Definition

SHALL be present. Reference to the associated proband Patient for which this family history is being obtained. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS

Cardinality1..1
TypeReference(Patient | NHSEngland_Patient_Genomics)
Must SupportTrue
SummaryTrue
AliasProband
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
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
FamilyMemberHistory.date
ShortWhen history was recorded or last updated
Definition

The date (and possibly time) when the family member history was recorded or last updated.

Cardinality0..1
TypedateTime
Must SupportTrue
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
FamilyMemberHistory.name
ShortThe family member described
Definition

This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
Requirements

Allows greater ease in ensuring the same person is being talked about.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: name
FamilyMemberHistory.relationship
ShortRelationship to the subject
Definition

SHALL be present. Relationship between the person the FamilyMemberHistory references and the proband Patient. Clinical histories for each family member are expected to be recorded in separate FamilyMemberHistory resources. If multiple resources are required, both FamilyMemberHistory and related clinical artifacts such as Condition/Observation resources, these MAY be contained within a List resource to improve readability.

Cardinality1..1
TypeCodeableConcept
Binding

The nature of the relationship between the patient and the related person being described in the family member history.

UKCorePersonRelationshipType (extensible)

Must SupportTrue
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
FamilyMemberHistory.sex
Shortmale | female | other | unknown
Definition

The birth sex of the family member.

Cardinality0..1
TypeCodeableConcept
Binding

Codes describing the sex assigned at birth as documented on the birth registration.

AdministrativeGender (extensible)

SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
FamilyMemberHistory.born[x]
Short(approximate) date of birth
Definition

The actual or approximate date of birth of the relative.

Cardinality0..1
Typedate | Period | string
Requirements

Allows calculation of the relative's age.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, fhs-1
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)
FamilyMemberHistory.age[x]
Short(approximate) age
Definition

The age of the relative at the time the family member history is recorded.

Cardinality0..1
TypeAge | Range | string
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, fhs-1
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
FamilyMemberHistory.estimatedAge
ShortAge is estimated?
Definition

If true, indicates that the age value specified is an estimated value.

Cardinality0..1
Typeboolean
SummaryTrue
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.

Meaning when missing

It is unknown whether the age is an estimate or not

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, fhs-2
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.deceased[x]
ShortDead? 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.

Cardinality0..1
TypeAge | boolean | date | Range | string
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
FamilyMemberHistory.reasonCode
ShortWhy was family member history performed?
Definition

Describes why the family member history occurred in coded or textual form.

Cardinality0..*
TypeCodeableConcept
Binding

Codes indicating why the family member history was done.

SNOMEDCTClinicalFindings (example)

SummaryTrue
Comments

Textual reasons can be captured using reasonCode.text.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
FamilyMemberHistory.reasonReference
ShortWhy was family member history performed?
Definition

Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

Cardinality0..*
TypeReference(AllergyIntolerance | Condition | DiagnosticReport | DocumentReference | Observation | QuestionnaireResponse)
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
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
FamilyMemberHistory.note
ShortGeneral 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.

Cardinality0..*
TypeAnnotation
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).

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
FamilyMemberHistory.condition
ShortCondition 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.

Cardinality0..*
TypeBackboneElement
Must SupportTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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]
FamilyMemberHistory.condition.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
FamilyMemberHistory.condition.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.condition.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.condition.code
ShortCondition 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.

Cardinality1..1
TypeCodeableConcept
Binding

Identification of the Condition or diagnosis.

Condition/Problem/DiagnosisCodes (preferred)

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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
FamilyMemberHistory.condition.outcome
Shortdeceased | permanent disability | etc.
Definition

Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.

Cardinality0..1
TypeCodeableConcept
Binding

The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

ConditionOutcomeCodes (preferred)

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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
FamilyMemberHistory.condition.contributedToDeath
ShortWhether 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.

Cardinality0..1
Typeboolean
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.condition.onset[x]
ShortWhen 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.

Cardinality0..1
TypeAge | Period | Range | string
Requirements

Age of onset of a condition in relatives is predictive of risk for the patient.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
FamilyMemberHistory.condition.note
ShortExtra information about condition
Definition

An area where general notes can be placed about this specific condition.

Cardinality0..*
TypeAnnotation
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).

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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

FamilyMemberHistory0..*
FamilyMemberHistory.idid0..1
FamilyMemberHistory.metaMeta0..1
FamilyMemberHistory.implicitRulesuri0..1
FamilyMemberHistory.languagecode0..1
FamilyMemberHistory.textNarrative0..1
FamilyMemberHistory.containedResource0..*
FamilyMemberHistory.extensionExtension0..*
FamilyMemberHistory.extension:associatedEncounterExtension0..1
FamilyMemberHistory.extension:participantR5Extension0..*
FamilyMemberHistory.extension:participantR5.idstring0..1
FamilyMemberHistory.extension:participantR5.extensionExtension1..*
FamilyMemberHistory.extension:participantR5.extension:functionExtension0..1
FamilyMemberHistory.extension:participantR5.extension:function.idstring0..1
FamilyMemberHistory.extension:participantR5.extension:function.extensionExtension0..*
FamilyMemberHistory.extension:participantR5.extension:function.urluri1..1
FamilyMemberHistory.extension:participantR5.extension:function.value[x]CodeableConcept1..1
FamilyMemberHistory.extension:participantR5.extension:actorExtension1..1
FamilyMemberHistory.extension:participantR5.extension:actor.idstring0..1
FamilyMemberHistory.extension:participantR5.extension:actor.extensionExtension0..*
FamilyMemberHistory.extension:participantR5.extension:actor.urluri1..1
FamilyMemberHistory.extension:participantR5.extension:actor.value[x]Reference(CareTeam | Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)1..1
FamilyMemberHistory.extension:participantR5.urluri1..1
FamilyMemberHistory.extension:participantR5.value[x]Address | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid0..0
FamilyMemberHistory.extension:fMHObservationExtension0..*
FamilyMemberHistory.modifierExtensionExtension0..*
FamilyMemberHistory.identifierIdentifier0..1
FamilyMemberHistory.instantiatesCanonicalcanonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)0..*
FamilyMemberHistory.instantiatesUriuri0..*
FamilyMemberHistory.statuscode1..1
FamilyMemberHistory.dataAbsentReasonCodeableConcept0..1
FamilyMemberHistory.patientReference(Patient | NHSEngland_Patient_Genomics)1..1
FamilyMemberHistory.datedateTime0..1
FamilyMemberHistory.namestring0..1
FamilyMemberHistory.relationshipCodeableConcept1..1
FamilyMemberHistory.sexCodeableConcept0..1
FamilyMemberHistory.born[x]date | Period | string0..1
FamilyMemberHistory.age[x]Age | Range | string0..1
FamilyMemberHistory.estimatedAgeboolean0..1
FamilyMemberHistory.deceased[x]Age | boolean | date | Range | string0..1
FamilyMemberHistory.reasonCodeCodeableConcept0..*
FamilyMemberHistory.reasonReferenceReference(AllergyIntolerance | Condition | DiagnosticReport | DocumentReference | Observation | QuestionnaireResponse)0..*
FamilyMemberHistory.noteAnnotation0..*
FamilyMemberHistory.conditionBackboneElement0..*
FamilyMemberHistory.condition.idstring0..1
FamilyMemberHistory.condition.extensionExtension0..*
FamilyMemberHistory.condition.modifierExtensionExtension0..*
FamilyMemberHistory.condition.codeCodeableConcept1..1
FamilyMemberHistory.condition.outcomeCodeableConcept0..1
FamilyMemberHistory.condition.contributedToDeathboolean0..1
FamilyMemberHistory.condition.onset[x]Age | Period | Range | string0..1
FamilyMemberHistory.condition.noteAnnotation0..*

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="NHSEngland-FamilyMemberHistory-Genomics" />
<url value="https://fhir.nhs.uk/StructureDefinition/NHSEngland-FamilyMemberHistory-Genomics" />
<version value="0.3.0" />
<name value="NHSEngland_FamilyMemberHistory_Genomics" />
<title value="NHSEngland FamilyMemberHistory Genomics" />
<status value="active" />
<date value="2026-04-16" />
<publisher value="NHS England" />
<name value="NHS England" />
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="This profile defines the Genomics constraints and extensions on the UK Core FHIR resource [FamilyMemberHistory](https://fhir.hl7.org.uk/StructureDefinition/UKCore-FamilyMemberHistory)." />
<purpose value="For collecting relevant Family Member History to aid interpretation of Genomic results. This is limited to collection of Pedigree information. The FamilyMemberHistory resource is not to be used to record participants involved in testing, e.g. in the case of Duo/Trio scenarios (in this case the RelatedPerson resource SHOULD be used instead)." />
<copyright value="Copyright © 2026+ NHS England 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 value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="FamilyMemberHistory" />
<baseDefinition value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-FamilyMemberHistory" />
<derivation value="constraint" />
<element id="FamilyMemberHistory">
<path value="FamilyMemberHistory" />
<short value="Information about patient's relatives, relevant for patient" />
<definition value="Significant health conditions for a person related to the patient relevant in the context of care for the patient." />
<min value="0" />
<max value="*" />
<path value="FamilyMemberHistory" />
<min value="0" />
<max value="*" />
</base>
<key value="dom-2" />
<severity value="error" />
<human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" />
<expression value="contained.contained.empty()" />
<xpath value="not(parent::f:contained and f:contained)" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<key value="dom-4" />
<severity value="error" />
<human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" />
<expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" />
<xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<key value="dom-3" />
<severity value="error" />
<human value="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" />
<expression value="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()" />
<xpath value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice">
<valueBoolean value="true" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation">
<valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." />
</extension>
<key value="dom-6" />
<severity value="warning" />
<human value="A resource should have narrative for robust management" />
<expression value="text.`div`.exists()" />
<xpath value="exists(f:text/h:div)" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<key value="dom-5" />
<severity value="error" />
<human value="If a resource is contained in another resource, it SHALL NOT have a security label" />
<expression value="contained.meta.security.empty()" />
<xpath value="not(exists(f:contained/*/f:meta/f:security))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<key value="fhs-2" />
<severity value="error" />
<human value="Can only have estimatedAge if age[x] is present" />
<expression value="age.exists() or estimatedAge.empty()" />
<xpath value="exists(*[starts-with(local-name(.), 'age')]) or not(exists(f:estimatedAge))" />
<source value="http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory" />
</constraint>
<key value="fhs-1" />
<severity value="error" />
<human value="Can have age[x] or born[x], but not both" />
<expression value="age.empty() or born.empty()" />
<xpath value="not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])" />
<source value="http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory" />
</constraint>
<identity value="rim" />
<map value="Entity. Role, or Act" />
</mapping>
<identity value="workflow" />
<map value="Event" />
</mapping>
<identity value="v2" />
<map value="Not in scope for v2" />
</mapping>
<identity value="rim" />
<map value="Observation[classCode=OBS, moodCode=EVN]" />
</mapping>
</element>
<element id="FamilyMemberHistory.id">
<path value="FamilyMemberHistory.id" />
<short value="Logical id of this artifact" />
<definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." />
<comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." />
<min value="0" />
<max value="1" />
<path value="Resource.id" />
<min value="0" />
<max value="1" />
</base>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="id" />
</extension>
<code value="id" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.meta">
<path value="FamilyMemberHistory.meta" />
<short value="Metadata about the resource" />
<definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." />
<min value="0" />
<max value="1" />
<path value="Resource.meta" />
<min value="0" />
<max value="1" />
</base>
<code value="Meta" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.implicitRules">
<path value="FamilyMemberHistory.implicitRules" />
<short value="A set of rules under which this content was created" />
<definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc." />
<comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc." />
<min value="0" />
<max value="1" />
<path value="Resource.implicitRules" />
<min value="0" />
<max value="1" />
</base>
<code value="uri" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="true" />
<isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation" />
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.language">
<path value="FamilyMemberHistory.language" />
<short value="Language of the resource content" />
<definition value="The base language in which the resource is written." />
<comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)." />
<min value="0" />
<max value="1" />
<path value="Resource.language" />
<min value="0" />
<max value="1" />
</base>
<code value="code" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
<valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Language" />
</extension>
<strength value="preferred" />
<description value="A human language." />
<valueSet value="http://hl7.org/fhir/ValueSet/languages" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.text">
<path value="FamilyMemberHistory.text" />
<short value="Text summary of the resource, for human interpretation" />
<definition value="A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety." />
<comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later." />
<alias value="narrative" />
<alias value="html" />
<alias value="xhtml" />
<alias value="display" />
<min value="0" />
<max value="1" />
<path value="DomainResource.text" />
<min value="0" />
<max value="1" />
</base>
<code value="Narrative" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
<identity value="rim" />
<map value="Act.text?" />
</mapping>
</element>
<element id="FamilyMemberHistory.contained">
<path value="FamilyMemberHistory.contained" />
<short value="Contained, inline Resources" />
<definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope." />
<comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels." />
<alias value="inline resources" />
<alias value="anonymous resources" />
<alias value="contained resources" />
<min value="0" />
<max value="*" />
<path value="DomainResource.contained" />
<min value="0" />
<max value="*" />
</base>
<code value="Resource" />
</type>
<identity value="rim" />
<map value="Entity. Role, or Act" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension">
<path value="FamilyMemberHistory.extension" />
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<path value="DomainResource.extension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:associatedEncounter">
<path value="FamilyMemberHistory.extension" />
<sliceName value="associatedEncounter" />
<short value="An associated encounter reference." />
<definition value="An associated encounter reference." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="1" />
<path value="DomainResource.extension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5">
<path value="FamilyMemberHistory.extension" />
<sliceName value="participantR5" />
<short value="Who or what participated in the activities related to the family member history. This is a R5 backport." />
<definition value="An extension to record who or what participated in the activities related to the family member history." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<path value="DomainResource.extension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
<profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5.id">
<path value="FamilyMemberHistory.extension.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5.extension">
<path value="FamilyMemberHistory.extension.extension" />
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="1" />
<max value="*" />
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5.extension:function">
<path value="FamilyMemberHistory.extension.extension" />
<sliceName value="function" />
<short value="The type of involvement in the activities related to the family member history." />
<definition value="Distinguishes the type of involvement of the actor in the activities related to the family member history." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="1" />
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<strength value="extensible" />
<valueSet value="http://hl7.org/fhir/ValueSet/participation-role-type" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5.extension:function.id">
<path value="FamilyMemberHistory.extension.extension.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5.extension:function.extension">
<path value="FamilyMemberHistory.extension.extension.extension" />
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5.extension:function.url">
<path value="FamilyMemberHistory.extension.extension.url" />
<representation value="xmlAttr" />
<short value="identifies the meaning of the extension" />
<definition value="Source of the definition for the extension code - a logical name or a URL." />
<comment value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension." />
<min value="1" />
<max value="1" />
<path value="Extension.url" />
<min value="1" />
<max value="1" />
</base>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="uri" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<fixedUri value="function" />
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5.extension:function.value[x]">
<path value="FamilyMemberHistory.extension.extension.value[x]" />
<short value="The type of involvement in the activities related to the family member history" />
<definition value="This FHIR value set is comprised of Actor participation Type codes, which can be used to value FHIR agents, actors, and other role elements. The codes are intended to express how the agent participated in some activity. Sometimes referred to the agent functional-role relative to the activity." />
<min value="1" />
<max value="1" />
<path value="Extension.value[x]" />
<min value="0" />
<max value="1" />
</base>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5.extension:actor">
<path value="FamilyMemberHistory.extension.extension" />
<sliceName value="actor" />
<short value="Who or what participated in the activities related to the family member history." />
<definition value="Indicates who or what participated in the activities related to the family member history." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="1" />
<max value="1" />
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5.extension:actor.id">
<path value="FamilyMemberHistory.extension.extension.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5.extension:actor.extension">
<path value="FamilyMemberHistory.extension.extension.extension" />
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5.extension:actor.url">
<path value="FamilyMemberHistory.extension.extension.url" />
<representation value="xmlAttr" />
<short value="identifies the meaning of the extension" />
<definition value="Source of the definition for the extension code - a logical name or a URL." />
<comment value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension." />
<min value="1" />
<max value="1" />
<path value="Extension.url" />
<min value="1" />
<max value="1" />
</base>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="uri" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<fixedUri value="actor" />
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5.extension:actor.value[x]">
<path value="FamilyMemberHistory.extension.extension.value[x]" />
<short value="Who or what participated in the activities related to the family member history" />
<definition value="A reference to a Patient, Practitioner, PractitionerRole, RelatedPerson, Device, Organization, or CareTeam." />
<min value="1" />
<max value="1" />
<path value="Extension.value[x]" />
<min value="0" />
<max value="1" />
</base>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/CareTeam" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5.url">
<path value="FamilyMemberHistory.extension.url" />
<representation value="xmlAttr" />
<short value="identifies the meaning of the extension" />
<definition value="Source of the definition for the extension code - a logical name or a URL." />
<comment value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension." />
<min value="1" />
<max value="1" />
<path value="Extension.url" />
<min value="1" />
<max value="1" />
</base>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="uri" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<fixedUri value="http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant" />
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:participantR5.value[x]">
<path value="FamilyMemberHistory.extension.value[x]" />
<short value="Value of extension" />
<definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)." />
<min value="0" />
<max value="0" />
<path value="Extension.value[x]" />
<min value="0" />
<max value="1" />
</base>
<code value="base64Binary" />
</type>
<code value="boolean" />
</type>
<code value="canonical" />
</type>
<code value="code" />
</type>
<code value="date" />
</type>
<code value="dateTime" />
</type>
<code value="decimal" />
</type>
<code value="id" />
</type>
<code value="instant" />
</type>
<code value="integer" />
</type>
<code value="markdown" />
</type>
<code value="oid" />
</type>
<code value="positiveInt" />
</type>
<code value="string" />
</type>
<code value="time" />
</type>
<code value="unsignedInt" />
</type>
<code value="uri" />
</type>
<code value="url" />
</type>
<code value="uuid" />
</type>
<code value="Address" />
</type>
<code value="Age" />
</type>
<code value="Annotation" />
</type>
<code value="Attachment" />
</type>
<code value="CodeableConcept" />
</type>
<code value="Coding" />
</type>
<code value="ContactPoint" />
</type>
<code value="Count" />
</type>
<code value="Distance" />
</type>
<code value="Duration" />
</type>
<code value="HumanName" />
</type>
<code value="Identifier" />
</type>
<code value="Money" />
</type>
<code value="Period" />
</type>
<code value="Quantity" />
</type>
<code value="Range" />
</type>
<code value="Ratio" />
</type>
<code value="Reference" />
</type>
<code value="SampledData" />
</type>
<code value="Signature" />
</type>
<code value="Timing" />
</type>
<code value="ContactDetail" />
</type>
<code value="Contributor" />
</type>
<code value="DataRequirement" />
</type>
<code value="Expression" />
</type>
<code value="ParameterDefinition" />
</type>
<code value="RelatedArtifact" />
</type>
<code value="TriggerDefinition" />
</type>
<code value="UsageContext" />
</type>
<code value="Dosage" />
</type>
<code value="Meta" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.extension:fMHObservation">
<path value="FamilyMemberHistory.extension" />
<sliceName value="fMHObservation" />
<short value="Genetic markers, ethnicity, etc." />
<definition value="An extension on the FamilyMemberHistory resource to include Observations relevant to Genomic testing/interpretation." />
<comment value="This may be extended with additional genomics-specific resources when they are ready." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<path value="DomainResource.extension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
<profile value="http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-observation" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
<identity value="rim" />
<map value="inboundRelationship[typeCode=SUBJ].source" />
</mapping>
</element>
<element id="FamilyMemberHistory.modifierExtension">
<path value="FamilyMemberHistory.modifierExtension" />
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Extensions that cannot be ignored" />
<definition value="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<path value="DomainResource.modifierExtension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="true" />
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.identifier">
<path value="FamilyMemberHistory.identifier" />
<short value="External Id(s) for this record" />
<definition value="This SHOULD be NHS number or local identifier (if NHS number is unavailable e.g. for non UK residents), though this MAY be omitted if no identifier for the family member is known. If a local identifier is used, an assigner SHALL be provided. The FamilyMemberHistory.identifier field SHALL match the identifier used for a RelatedPerson resource if the same person is being referenced." />
<comment value="This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). 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." />
<requirements value="Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers." />
<min value="0" />
<max value="1" />
<path value="FamilyMemberHistory.identifier" />
<min value="0" />
<max value="*" />
</base>
<code value="Identifier" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CX / EI (occasionally, more often EI maps to a resource id or a URL)" />
</mapping>
<identity value="rim" />
<map value="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]" />
</mapping>
<identity value="servd" />
<map value="Identifier" />
</mapping>
<identity value="workflow" />
<map value="Event.identifier" />
</mapping>
<identity value="w5" />
<map value="FiveWs.identifier" />
</mapping>
<identity value="rim" />
<map value="id" />
</mapping>
</element>
<element id="FamilyMemberHistory.instantiatesCanonical">
<path value="FamilyMemberHistory.instantiatesCanonical" />
<short value="Instantiates FHIR protocol or definition" />
<definition value="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." />
<comment value="see [Canonical References](references.html#canonical)" />
<min value="0" />
<max value="*" />
<path value="FamilyMemberHistory.instantiatesCanonical" />
<min value="0" />
<max value="*" />
</base>
<code value="canonical" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/PlanDefinition" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/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>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="workflow" />
<map value="Event.instantiatesCanonical" />
</mapping>
<identity value="rim" />
<map value=".outboundRelationship[typeCode=DEFN].target" />
</mapping>
</element>
<element id="FamilyMemberHistory.instantiatesUri">
<path value="FamilyMemberHistory.instantiatesUri" />
<short value="Instantiates external protocol or definition" />
<definition value="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." />
<comment value="This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier." />
<min value="0" />
<max value="*" />
<path value="FamilyMemberHistory.instantiatesUri" />
<min value="0" />
<max value="*" />
</base>
<code value="uri" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="workflow" />
<map value="Event.instantiatesUri" />
</mapping>
<identity value="rim" />
<map value=".outboundRelationship[typeCode=DEFN].target" />
</mapping>
</element>
<element id="FamilyMemberHistory.status">
<path value="FamilyMemberHistory.status" />
<short value="partial | completed | entered-in-error | health-unknown" />
<definition value="Used to mark the completeness of a given family member's clinical history. If the history of a family member is expected but no history could be obtained, this element SHOULD be filled with 'health-unknown'.\nAssertions regarding absence of relevant history SHOULD follow guidance within the HL7 FHIR R4 FamilyMemberHistory resource" />
<comment value="This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid." />
<min value="1" />
<max value="1" />
<path value="FamilyMemberHistory.status" />
<min value="1" />
<max value="1" />
</base>
<code value="code" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isModifier value="true" />
<isModifierReason value="This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid" />
<isSummary value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="FamilyHistoryStatus" />
</extension>
<strength value="required" />
<description value="A code that identifies the status of the family history record." />
<valueSet value="http://hl7.org/fhir/ValueSet/history-status|4.0.1" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="workflow" />
<map value="Event.status" />
</mapping>
<identity value="w5" />
<map value="FiveWs.status" />
</mapping>
</element>
<element id="FamilyMemberHistory.dataAbsentReason">
<path value="FamilyMemberHistory.dataAbsentReason" />
<short value="subject-unknown | withheld | unable-to-obtain | deferred" />
<definition value="Describes why the family member's history is not available." />
<comment value="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." />
<requirements value="This is a separate element to allow it to have a distinct binding from reasonCode." />
<min value="0" />
<max value="1" />
<path value="FamilyMemberHistory.dataAbsentReason" />
<min value="0" />
<max value="1" />
</base>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="FamilyHistoryAbsentReason" />
</extension>
<strength value="extensible" />
<description value="Codes describing the reason why a family member's history is not available." />
<valueSet value="http://hl7.org/fhir/ValueSet/history-absent-reason" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<identity value="rim" />
<map value=".reasonCode" />
</mapping>
</element>
<element id="FamilyMemberHistory.patient">
<path value="FamilyMemberHistory.patient" />
<short value="Patient history is about" />
<definition value="SHALL be present. Reference to the associated proband Patient for which this family history is being obtained. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS" />
<comment value="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." />
<alias value="Proband" />
<min value="1" />
<max value="1" />
<path value="FamilyMemberHistory.patient" />
<min value="1" />
<max value="1" />
</base>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/StructureDefinition/NHSEngland-Patient-Genomics" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
<aggregation value="referenced" />
<aggregation value="bundled" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<identity value="workflow" />
<map value="Event.subject" />
</mapping>
<identity value="w5" />
<map value="FiveWs.subject[x]" />
</mapping>
<identity value="rim" />
<map value="participation[typeCode=SBJ].role" />
</mapping>
<identity value="w5" />
<map value="FiveWs.subject" />
</mapping>
</element>
<element id="FamilyMemberHistory.date">
<path value="FamilyMemberHistory.date" />
<short value="When history was recorded or last updated" />
<definition value="The date (and possibly time) when the family member history was recorded or last updated." />
<comment value="This should be captured even if the same as the date on the List aggregating the full family history." />
<requirements value="Allows determination of how current the summary is." />
<min value="0" />
<max value="1" />
<path value="FamilyMemberHistory.date" />
<min value="0" />
<max value="1" />
</base>
<code value="dateTime" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="w5" />
<map value="FiveWs.recorded" />
</mapping>
<identity value="rim" />
<map value="participation[typeCode=AUT].time" />
</mapping>
</element>
<element id="FamilyMemberHistory.name">
<path value="FamilyMemberHistory.name" />
<short value="The family member described" />
<definition value="This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair"." />
<comment value="Note that FHIR strings SHALL NOT exceed 1MB in size" />
<requirements value="Allows greater ease in ensuring the same person is being talked about." />
<min value="0" />
<max value="1" />
<path value="FamilyMemberHistory.name" />
<min value="0" />
<max value="1" />
</base>
<code value="string" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="name" />
</mapping>
</element>
<element id="FamilyMemberHistory.relationship">
<path value="FamilyMemberHistory.relationship" />
<short value="Relationship to the subject" />
<definition value="SHALL be present. Relationship between the person the FamilyMemberHistory references and the proband Patient. Clinical histories for each family member are expected to be recorded in separate FamilyMemberHistory resources. If multiple resources are required, both FamilyMemberHistory and related clinical artifacts such as Condition/Observation resources, these MAY be contained within a List resource to improve readability." />
<comment value="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." />
<min value="1" />
<max value="1" />
<path value="FamilyMemberHistory.relationship" />
<min value="1" />
<max value="1" />
</base>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="FamilialRelationship" />
</extension>
<strength value="extensible" />
<description value="The nature of the relationship between the patient and the related person being described in the family member history." />
<valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<identity value="rim" />
<map value="code" />
</mapping>
</element>
<element id="FamilyMemberHistory.sex">
<path value="FamilyMemberHistory.sex" />
<short value="male | female | other | unknown" />
<definition value="The birth sex of the family member." />
<comment value="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." />
<requirements value="Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments." />
<min value="0" />
<max value="1" />
<path value="FamilyMemberHistory.sex" />
<min value="0" />
<max value="1" />
</base>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Sex" />
</extension>
<strength value="extensible" />
<description value="Codes describing the sex assigned at birth as documented on the birth registration." />
<valueSet value="http://hl7.org/fhir/ValueSet/administrative-gender" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
</element>
<element id="FamilyMemberHistory.born[x]">
<path value="FamilyMemberHistory.born[x]" />
<short value="(approximate) date of birth" />
<definition value="The actual or approximate date of birth of the relative." />
<requirements value="Allows calculation of the relative's age." />
<min value="0" />
<max value="1" />
<path value="FamilyMemberHistory.born[x]" />
<min value="0" />
<max value="1" />
</base>
<code value="Period" />
</type>
<code value="date" />
</type>
<code value="string" />
</type>
<condition value="ele-1" />
<condition value="fhs-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)" />
</mapping>
</element>
<element id="FamilyMemberHistory.age[x]">
<path value="FamilyMemberHistory.age[x]" />
<short value="(approximate) age" />
<definition value="The age of the relative at the time the family member history is recorded." />
<comment value="use estimatedAge to indicate whether the age is actual or not." />
<requirements value="While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians." />
<min value="0" />
<max value="1" />
<path value="FamilyMemberHistory.age[x]" />
<min value="0" />
<max value="1" />
</base>
<code value="Age" />
</type>
<code value="Range" />
</type>
<code value="string" />
</type>
<condition value="ele-1" />
<condition value="fhs-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code="age"].value" />
</mapping>
</element>
<element id="FamilyMemberHistory.estimatedAge">
<path value="FamilyMemberHistory.estimatedAge" />
<short value="Age is estimated?" />
<definition value="If true, indicates that the age value specified is an estimated value." />
<comment value="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." />
<requirements value="Clinicians often prefer to specify an estimaged age rather than an age range." />
<min value="0" />
<max value="1" />
<path value="FamilyMemberHistory.estimatedAge" />
<min value="0" />
<max value="1" />
</base>
<code value="boolean" />
</type>
<meaningWhenMissing value="It is unknown whether the age is an estimate or not" />
<condition value="ele-1" />
<condition value="fhs-2" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.deceased[x]">
<path value="FamilyMemberHistory.deceased[x]" />
<short value="Dead? How old/when?" />
<definition value="Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record." />
<min value="0" />
<max value="1" />
<path value="FamilyMemberHistory.deceased[x]" />
<min value="0" />
<max value="1" />
</base>
<code value="boolean" />
</type>
<code value="Age" />
</type>
<code value="Range" />
</type>
<code value="date" />
</type>
<code value="string" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role" />
</mapping>
</element>
<element id="FamilyMemberHistory.reasonCode">
<path value="FamilyMemberHistory.reasonCode" />
<short value="Why was family member history performed?" />
<definition value="Describes why the family member history occurred in coded or textual form." />
<comment value="Textual reasons can be captured using reasonCode.text." />
<min value="0" />
<max value="*" />
<path value="FamilyMemberHistory.reasonCode" />
<min value="0" />
<max value="*" />
</base>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="FamilyHistoryReason" />
</extension>
<strength value="example" />
<description value="Codes indicating why the family member history was done." />
<valueSet value="http://hl7.org/fhir/ValueSet/clinical-findings" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<identity value="workflow" />
<map value="Event.reasonCode" />
</mapping>
<identity value="w5" />
<map value="FiveWs.why[x]" />
</mapping>
<identity value="rim" />
<map value=".reasonCode" />
</mapping>
</element>
<element id="FamilyMemberHistory.reasonReference">
<path value="FamilyMemberHistory.reasonReference" />
<short value="Why was family member history performed?" />
<definition value="Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event." />
<comment value="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." />
<min value="0" />
<max value="*" />
<path value="FamilyMemberHistory.reasonReference" />
<min value="0" />
<max value="*" />
</base>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Condition" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/AllergyIntolerance" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/DiagnosticReport" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/DocumentReference" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<identity value="workflow" />
<map value="Event.reasonReference" />
</mapping>
<identity value="w5" />
<map value="FiveWs.why[x]" />
</mapping>
<identity value="rim" />
<map value=".outboundRelationship[typeCode=RSON].target" />
</mapping>
</element>
<element id="FamilyMemberHistory.note">
<path value="FamilyMemberHistory.note" />
<short value="General note about related person" />
<definition value="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." />
<comment value="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)." />
<min value="0" />
<max value="*" />
<path value="FamilyMemberHistory.note" />
<min value="0" />
<max value="*" />
</base>
<code value="Annotation" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="N/A" />
</mapping>
<identity value="rim" />
<map value="Act" />
</mapping>
<identity value="workflow" />
<map value="Event.note" />
</mapping>
<identity value="rim" />
<map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition">
<path value="FamilyMemberHistory.condition" />
<short value="Condition that the related person had" />
<definition value="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." />
<min value="0" />
<max value="*" />
<path value="FamilyMemberHistory.condition" />
<min value="0" />
<max value="*" />
</base>
<code value="BackboneElement" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.id">
<path value="FamilyMemberHistory.condition.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.extension">
<path value="FamilyMemberHistory.condition.extension" />
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.modifierExtension">
<path value="FamilyMemberHistory.condition.modifierExtension" />
<short value="Extensions that cannot be ignored even if unrecognized" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." />
<alias value="extensions" />
<alias value="user content" />
<alias value="modifiers" />
<min value="0" />
<max value="*" />
<path value="BackboneElement.modifierExtension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="true" />
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.code">
<path value="FamilyMemberHistory.condition.code" />
<short value="Condition suffered by relation" />
<definition value="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." />
<comment value="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." />
<min value="1" />
<max value="1" />
<path value="FamilyMemberHistory.condition.code" />
<min value="1" />
<max value="1" />
</base>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="ConditionCode" />
</extension>
<strength value="preferred" />
<description value="Identification of the Condition or diagnosis." />
<valueSet value="http://hl7.org/fhir/ValueSet/condition-code" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<identity value="rim" />
<map value=".value" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.outcome">
<path value="FamilyMemberHistory.condition.outcome" />
<short value="deceased | permanent disability | etc." />
<definition value="Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation." />
<comment value="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." />
<min value="0" />
<max value="1" />
<path value="FamilyMemberHistory.condition.outcome" />
<min value="0" />
<max value="1" />
</base>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="ConditionOutcome" />
</extension>
<strength value="preferred" />
<description value="The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc." />
<valueSet value="http://hl7.org/fhir/ValueSet/condition-outcome" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<identity value="rim" />
<map value="outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.contributedToDeath">
<path value="FamilyMemberHistory.condition.contributedToDeath" />
<short value="Whether the condition contributed to the cause of death" />
<definition value="This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown." />
<min value="0" />
<max value="1" />
<path value="FamilyMemberHistory.condition.contributedToDeath" />
<min value="0" />
<max value="1" />
</base>
<code value="boolean" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.onset[x]">
<path value="FamilyMemberHistory.condition.onset[x]" />
<short value="When condition first manifested" />
<definition value="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 value="Age of onset of a condition in relatives is predictive of risk for the patient." />
<min value="0" />
<max value="1" />
<path value="FamilyMemberHistory.condition.onset[x]" />
<min value="0" />
<max value="1" />
</base>
<code value="Age" />
</type>
<code value="Range" />
</type>
<code value="Period" />
</type>
<code value="string" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="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" />
</mapping>
</element>
<element id="FamilyMemberHistory.condition.note">
<path value="FamilyMemberHistory.condition.note" />
<short value="Extra information about condition" />
<definition value="An area where general notes can be placed about this specific condition." />
<comment value="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)." />
<min value="0" />
<max value="*" />
<path value="FamilyMemberHistory.condition.note" />
<min value="0" />
<max value="*" />
</base>
<code value="Annotation" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="N/A" />
</mapping>
<identity value="rim" />
<map value="Act" />
</mapping>
<identity value="rim" />
<map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value" />
</mapping>
</element>
</snapshot>
<element id="FamilyMemberHistory.extension:fMHObservation">
<path value="FamilyMemberHistory.extension" />
<sliceName value="fMHObservation" />
<definition value="An extension on the FamilyMemberHistory resource to include Observations relevant to Genomic testing/interpretation." />
<code value="Extension" />
<profile value="http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-observation" />
</type>
</element>
<element id="FamilyMemberHistory.identifier">
<path value="FamilyMemberHistory.identifier" />
<definition value="This SHOULD be NHS number or local identifier (if NHS number is unavailable e.g. for non UK residents), though this MAY be omitted if no identifier for the family member is known. If a local identifier is used, an assigner SHALL be provided. The FamilyMemberHistory.identifier field SHALL match the identifier used for a RelatedPerson resource if the same person is being referenced." />
<max value="1" />
</element>
<element id="FamilyMemberHistory.status">
<path value="FamilyMemberHistory.status" />
<definition value="Used to mark the completeness of a given family member's clinical history. If the history of a family member is expected but no history could be obtained, this element SHOULD be filled with 'health-unknown'.\nAssertions regarding absence of relevant history SHOULD follow guidance within the HL7 FHIR R4 FamilyMemberHistory resource" />
</element>
<element id="FamilyMemberHistory.patient">
<path value="FamilyMemberHistory.patient" />
<definition value="SHALL be present. Reference to the associated proband Patient for which this family history is being obtained. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS" />
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/StructureDefinition/NHSEngland-Patient-Genomics" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
<aggregation value="referenced" />
<aggregation value="bundled" />
</type>
</element>
<element id="FamilyMemberHistory.relationship">
<path value="FamilyMemberHistory.relationship" />
<definition value="SHALL be present. Relationship between the person the FamilyMemberHistory references and the proband Patient. Clinical histories for each family member are expected to be recorded in separate FamilyMemberHistory resources. If multiple resources are required, both FamilyMemberHistory and related clinical artifacts such as Condition/Observation resources, these MAY be contained within a List resource to improve readability." />
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "NHSEngland-FamilyMemberHistory-Genomics",
"url": "https://fhir.nhs.uk/StructureDefinition/NHSEngland-FamilyMemberHistory-Genomics",
"version": "0.3.0",
"name": "NHSEngland_FamilyMemberHistory_Genomics",
"title": "NHSEngland FamilyMemberHistory Genomics",
"status": "active",
"date": "2026-04-16",
"publisher": "NHS England",
"contact": [
{
"name": "NHS England",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work",
"rank": 1
}
]
}
],
"description": "This profile defines the Genomics constraints and extensions on the UK Core FHIR resource [FamilyMemberHistory](https://fhir.hl7.org.uk/StructureDefinition/UKCore-FamilyMemberHistory).",
"purpose": "For collecting relevant Family Member History to aid interpretation of Genomic results. This is limited to collection of Pedigree information. The FamilyMemberHistory resource is not to be used to record participants involved in testing, e.g. in the case of Duo/Trio scenarios (in this case the RelatedPerson resource SHOULD be used instead).",
"copyright": "Copyright © 2026+ NHS England 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": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-FamilyMemberHistory",
"derivation": "constraint",
"element": [
{
"id": "FamilyMemberHistory",
"path": "FamilyMemberHistory",
"short": "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.",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory",
"min": 0,
"max": "*"
},
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "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()",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key": "dom-6",
"severity": "warning",
"human": "A resource should have narrative for robust management",
"expression": "text.`div`.exists()",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-5",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression": "contained.meta.security.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "fhs-2",
"severity": "error",
"human": "Can only have estimatedAge if age[x] is present",
"expression": "age.exists() or estimatedAge.empty()",
"xpath": "exists(*[starts-with(local-name(.), 'age')]) or not(exists(f:estimatedAge))",
"source": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory"
},
{
"key": "fhs-1",
"severity": "error",
"human": "Can have age[x] or born[x], but not both",
"expression": "age.empty() or born.empty()",
"xpath": "not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])",
"source": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Event"
},
{
"identity": "v2",
"map": "Not in scope for v2"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
}
]
},
{
"id": "FamilyMemberHistory.id",
"path": "FamilyMemberHistory.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "id"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.meta",
"path": "FamilyMemberHistory.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.implicitRules",
"path": "FamilyMemberHistory.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.language",
"path": "FamilyMemberHistory.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"binding": {
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "preferred",
"description": "A human language.",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.text",
"path": "FamilyMemberHistory.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "FamilyMemberHistory.contained",
"path": "FamilyMemberHistory.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension",
"path": "FamilyMemberHistory.extension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension:associatedEncounter",
"path": "FamilyMemberHistory.extension",
"sliceName": "associatedEncounter",
"short": "An associated encounter reference.",
"definition": "An associated encounter reference.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter"
]
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5",
"path": "FamilyMemberHistory.extension",
"sliceName": "participantR5",
"short": "Who or what participated in the activities related to the family member history. This is a R5 backport.",
"definition": "An extension to record who or what participated in the activities related to the family member history.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant"
]
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5.id",
"path": "FamilyMemberHistory.extension.id",
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5.extension",
"path": "FamilyMemberHistory.extension.extension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 1,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5.extension:function",
"path": "FamilyMemberHistory.extension.extension",
"sliceName": "function",
"short": "The type of involvement in the activities related to the family member history.",
"definition": "Distinguishes the type of involvement of the actor in the activities related to the family member history.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/participation-role-type"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5.extension:function.id",
"path": "FamilyMemberHistory.extension.extension.id",
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5.extension:function.extension",
"path": "FamilyMemberHistory.extension.extension.extension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5.extension:function.url",
"path": "FamilyMemberHistory.extension.extension.url",
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "function",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5.extension:function.value[x]",
"path": "FamilyMemberHistory.extension.extension.value[x]",
"short": "The type of involvement in the activities related to the family member history",
"definition": "This FHIR value set is comprised of Actor participation Type codes, which can be used to value FHIR agents, actors, and other role elements. The codes are intended to express how the agent participated in some activity. Sometimes referred to the agent functional-role relative to the activity.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5.extension:actor",
"path": "FamilyMemberHistory.extension.extension",
"sliceName": "actor",
"short": "Who or what participated in the activities related to the family member history.",
"definition": "Indicates who or what participated in the activities related to the family member history.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5.extension:actor.id",
"path": "FamilyMemberHistory.extension.extension.id",
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5.extension:actor.extension",
"path": "FamilyMemberHistory.extension.extension.extension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5.extension:actor.url",
"path": "FamilyMemberHistory.extension.extension.url",
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "actor",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5.extension:actor.value[x]",
"path": "FamilyMemberHistory.extension.extension.value[x]",
"short": "Who or what participated in the activities related to the family member history",
"definition": "A reference to a Patient, Practitioner, PractitionerRole, RelatedPerson, Device, Organization, or CareTeam.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam"
]
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5.url",
"path": "FamilyMemberHistory.extension.url",
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension:participantR5.value[x]",
"path": "FamilyMemberHistory.extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"min": 0,
"max": "0",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "canonical"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "url"
},
{
"code": "uuid"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "ContactDetail"
},
{
"code": "Contributor"
},
{
"code": "DataRequirement"
},
{
"code": "Expression"
},
{
"code": "ParameterDefinition"
},
{
"code": "RelatedArtifact"
},
{
"code": "TriggerDefinition"
},
{
"code": "UsageContext"
},
{
"code": "Dosage"
},
{
"code": "Meta"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.extension:fMHObservation",
"path": "FamilyMemberHistory.extension",
"sliceName": "fMHObservation",
"short": "Genetic markers, ethnicity, etc.",
"definition": "An extension on the FamilyMemberHistory resource to include Observations relevant to Genomic testing/interpretation.",
"comment": "This may be extended with additional genomics-specific resources when they are ready.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-observation"
]
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source"
}
]
},
{
"id": "FamilyMemberHistory.modifierExtension",
"path": "FamilyMemberHistory.modifierExtension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.identifier",
"path": "FamilyMemberHistory.identifier",
"short": "External Id(s) for this record",
"definition": "This SHOULD be NHS number or local identifier (if NHS number is unavailable e.g. for non UK residents), though this MAY be omitted if no identifier for the family member is known. If a local identifier is used, an assigner SHALL be provided. The FamilyMemberHistory.identifier field SHALL match the identifier used for a RelatedPerson resource if the same person is being referenced.",
"comment": "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). 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.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity": "rim",
"map": "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]"
},
{
"identity": "servd",
"map": "Identifier"
},
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"id": "FamilyMemberHistory.instantiatesCanonical",
"path": "FamilyMemberHistory.instantiatesCanonical",
"short": "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.",
"comment": "see [Canonical References](references.html#canonical)",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.instantiatesCanonical",
"min": 0,
"max": "*"
},
"type": [
{
"code": "canonical",
"http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/Questionnaire",
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/Measure",
"http://hl7.org/fhir/StructureDefinition/OperationDefinition"
]
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "workflow",
"map": "Event.instantiatesCanonical"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target"
}
]
},
{
"id": "FamilyMemberHistory.instantiatesUri",
"path": "FamilyMemberHistory.instantiatesUri",
"short": "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.",
"comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.instantiatesUri",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "workflow",
"map": "Event.instantiatesUri"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target"
}
]
},
{
"id": "FamilyMemberHistory.status",
"path": "FamilyMemberHistory.status",
"short": "partial | completed | entered-in-error | health-unknown",
"definition": "Used to mark the completeness of a given family member's clinical history. If the history of a family member is expected but no history could be obtained, this element SHOULD be filled with 'health-unknown'.\nAssertions regarding absence of relevant history SHOULD follow guidance within the HL7 FHIR R4 FamilyMemberHistory resource",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min": 1,
"max": "1",
"base": {
"path": "FamilyMemberHistory.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": true,
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true,
"binding": {
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilyHistoryStatus"
}
],
"strength": "required",
"description": "A code that identifies the status of the family history record.",
"valueSet": "http://hl7.org/fhir/ValueSet/history-status|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
}
]
},
{
"id": "FamilyMemberHistory.dataAbsentReason",
"path": "FamilyMemberHistory.dataAbsentReason",
"short": "subject-unknown | withheld | unable-to-obtain | deferred",
"definition": "Describes why the family member's history is not available.",
"comment": "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.",
"requirements": "This is a separate element to allow it to have a distinct binding from reasonCode.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.dataAbsentReason",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilyHistoryAbsentReason"
}
],
"strength": "extensible",
"description": "Codes describing the reason why a family member's history is not available.",
"valueSet": "http://hl7.org/fhir/ValueSet/history-absent-reason"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "FamilyMemberHistory.patient",
"path": "FamilyMemberHistory.patient",
"short": "Patient history is about",
"definition": "SHALL be present. Reference to the associated proband Patient for which this family history is being obtained. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS",
"comment": "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.",
"alias": [
"Proband"
],
"min": 1,
"max": "1",
"base": {
"path": "FamilyMemberHistory.patient",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"https://fhir.nhs.uk/StructureDefinition/NHSEngland-Patient-Genomics",
"http://hl7.org/fhir/StructureDefinition/Patient"
],
"referenced",
"bundled"
]
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "rim",
"map": "participation[typeCode=SBJ].role"
},
{
"identity": "w5",
"map": "FiveWs.subject"
}
]
},
{
"id": "FamilyMemberHistory.date",
"path": "FamilyMemberHistory.date",
"short": "When history was recorded or last updated",
"definition": "The date (and possibly time) when the family member history was recorded or last updated.",
"comment": "This should be captured even if the same as the date on the List aggregating the full family history.",
"requirements": "Allows determination of how current the summary is.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
},
{
"identity": "rim",
"map": "participation[typeCode=AUT].time"
}
]
},
{
"id": "FamilyMemberHistory.name",
"path": "FamilyMemberHistory.name",
"short": "The family member described",
"definition": "This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\".",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"requirements": "Allows greater ease in ensuring the same person is being talked about.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "name"
}
]
},
{
"id": "FamilyMemberHistory.relationship",
"path": "FamilyMemberHistory.relationship",
"short": "Relationship to the subject",
"definition": "SHALL be present. Relationship between the person the FamilyMemberHistory references and the proband Patient. Clinical histories for each family member are expected to be recorded in separate FamilyMemberHistory resources. If multiple resources are required, both FamilyMemberHistory and related clinical artifacts such as Condition/Observation resources, these MAY be contained within a List resource to improve readability.",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "FamilyMemberHistory.relationship",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isSummary": true,
"binding": {
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilialRelationship"
}
],
"strength": "extensible",
"description": "The nature of the relationship between the patient and the related person being described in the family member history.",
"valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"id": "FamilyMemberHistory.sex",
"path": "FamilyMemberHistory.sex",
"short": "male | female | other | unknown",
"definition": "The birth sex of the family member.",
"comment": "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.",
"requirements": "Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.sex",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Sex"
}
],
"strength": "extensible",
"description": "Codes describing the sex assigned at birth as documented on the birth registration.",
"valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
}
]
},
{
"id": "FamilyMemberHistory.born[x]",
"path": "FamilyMemberHistory.born[x]",
"short": "(approximate) date of birth",
"definition": "The actual or approximate date of birth of the relative.",
"requirements": "Allows calculation of the relative's age.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.born[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
},
{
"code": "date"
},
{
"code": "string"
}
],
"ele-1",
"fhs-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)"
}
]
},
{
"id": "FamilyMemberHistory.age[x]",
"path": "FamilyMemberHistory.age[x]",
"short": "(approximate) age",
"definition": "The age of the relative at the time the family member history is recorded.",
"comment": "use estimatedAge to indicate whether the age is actual or not.",
"requirements": "While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.age[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "string"
}
],
"ele-1",
"fhs-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code=\"age\"].value"
}
]
},
{
"id": "FamilyMemberHistory.estimatedAge",
"path": "FamilyMemberHistory.estimatedAge",
"short": "Age is estimated?",
"definition": "If true, indicates that the age value specified is an estimated value.",
"comment": "This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age.",
"requirements": "Clinicians often prefer to specify an estimaged age rather than an age range.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.estimatedAge",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"meaningWhenMissing": "It is unknown whether the age is an estimate or not",
"ele-1",
"fhs-2"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.deceased[x]",
"path": "FamilyMemberHistory.deceased[x]",
"short": "Dead? How old/when?",
"definition": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.deceased[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
},
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "date"
},
{
"code": "string"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role"
}
]
},
{
"id": "FamilyMemberHistory.reasonCode",
"path": "FamilyMemberHistory.reasonCode",
"short": "Why was family member history performed?",
"definition": "Describes why the family member history occurred in coded or textual form.",
"comment": "Textual reasons can be captured using reasonCode.text.",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.reasonCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FamilyHistoryReason"
}
],
"strength": "example",
"description": "Codes indicating why the family member history was done.",
"valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "workflow",
"map": "Event.reasonCode"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "FamilyMemberHistory.reasonReference",
"path": "FamilyMemberHistory.reasonReference",
"short": "Why was family member history performed?",
"definition": "Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.",
"comment": "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.",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.reasonReference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"
]
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "workflow",
"map": "Event.reasonReference"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
}
]
},
{
"id": "FamilyMemberHistory.note",
"path": "FamilyMemberHistory.note",
"short": "General note about related person",
"definition": "This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.",
"comment": "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).",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act"
},
{
"identity": "workflow",
"map": "Event.note"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
},
{
"id": "FamilyMemberHistory.condition",
"path": "FamilyMemberHistory.condition",
"short": "Condition that the related person had",
"definition": "The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.condition",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]"
}
]
},
{
"id": "FamilyMemberHistory.condition.id",
"path": "FamilyMemberHistory.condition.id",
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.condition.extension",
"path": "FamilyMemberHistory.condition.extension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.condition.modifierExtension",
"path": "FamilyMemberHistory.condition.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FamilyMemberHistory.condition.code",
"path": "FamilyMemberHistory.condition.code",
"short": "Condition suffered by relation",
"definition": "The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "FamilyMemberHistory.condition.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"binding": {
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConditionCode"
}
],
"strength": "preferred",
"description": "Identification of the Condition or diagnosis.",
"valueSet": "http://hl7.org/fhir/ValueSet/condition-code"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "rim",
"map": ".value"
}
]
},
{
"id": "FamilyMemberHistory.condition.outcome",
"path": "FamilyMemberHistory.condition.outcome",
"short": "deceased | permanent disability | etc.",
"definition": "Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.condition.outcome",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"binding": {
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConditionOutcome"
}
],
"strength": "preferred",
"description": "The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.",
"valueSet": "http://hl7.org/fhir/ValueSet/condition-outcome"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "rim",
"map": "outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value"
}
]
},
{
"id": "FamilyMemberHistory.condition.contributedToDeath",
"path": "FamilyMemberHistory.condition.contributedToDeath",
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.condition.contributedToDeath",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FamilyMemberHistory.condition.onset[x]",
"path": "FamilyMemberHistory.condition.onset[x]",
"short": "When condition first manifested",
"definition": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.",
"requirements": "Age of onset of a condition in relatives is predictive of risk for the patient.",
"min": 0,
"max": "1",
"base": {
"path": "FamilyMemberHistory.condition.onset[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "Period"
},
{
"code": "string"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"Subject Age at measurement\", value<Diagnosis].value[@xsi:typeCode='TS' or 'IVL_TS'] Use originalText for string"
}
]
},
{
"id": "FamilyMemberHistory.condition.note",
"path": "FamilyMemberHistory.condition.note",
"short": "Extra information about condition",
"definition": "An area where general notes can be placed about this specific condition.",
"comment": "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).",
"min": 0,
"max": "*",
"base": {
"path": "FamilyMemberHistory.condition.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
}
]
},
"element": [
{
"id": "FamilyMemberHistory.extension:fMHObservation",
"path": "FamilyMemberHistory.extension",
"sliceName": "fMHObservation",
"definition": "An extension on the FamilyMemberHistory resource to include Observations relevant to Genomic testing/interpretation.",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-observation"
]
}
]
},
{
"id": "FamilyMemberHistory.identifier",
"path": "FamilyMemberHistory.identifier",
"definition": "This SHOULD be NHS number or local identifier (if NHS number is unavailable e.g. for non UK residents), though this MAY be omitted if no identifier for the family member is known. If a local identifier is used, an assigner SHALL be provided. The FamilyMemberHistory.identifier field SHALL match the identifier used for a RelatedPerson resource if the same person is being referenced.",
"max": "1"
},
{
"id": "FamilyMemberHistory.status",
"path": "FamilyMemberHistory.status",
"definition": "Used to mark the completeness of a given family member's clinical history. If the history of a family member is expected but no history could be obtained, this element SHOULD be filled with 'health-unknown'.\nAssertions regarding absence of relevant history SHOULD follow guidance within the HL7 FHIR R4 FamilyMemberHistory resource"
},
{
"id": "FamilyMemberHistory.patient",
"path": "FamilyMemberHistory.patient",
"definition": "SHALL be present. Reference to the associated proband Patient for which this family history is being obtained. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS",
"type": [
{
"code": "Reference",
"https://fhir.nhs.uk/StructureDefinition/NHSEngland-Patient-Genomics",
"http://hl7.org/fhir/StructureDefinition/Patient"
],
"referenced",
"bundled"
]
}
]
},
{
"id": "FamilyMemberHistory.relationship",
"path": "FamilyMemberHistory.relationship",
"definition": "SHALL be present. Relationship between the person the FamilyMemberHistory references and the proband Patient. Clinical histories for each family member are expected to be recorded in separate FamilyMemberHistory resources. If multiple resources are required, both FamilyMemberHistory and related clinical artifacts such as Condition/Observation resources, these MAY be contained within a List resource to improve readability."
}
]
}
}


FHIRMDSHL7v2
FamilyMemberHistoryPedigree details/diagram, Disease penetranceN/A not in scope for HL7v2, could be added as additional DG1 segments related to relatives (representation of family history in HL7v2 still pending investigation)

Additional Guidance

extension:genetics-observation

An extension on the FamilyMemberHistory resource to include Observations relevant to Genomic testing/interpretation.
"extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-observation",
            "valueReference": {
                "reference": "Observation/Observation-BloodPressure-Example"
            }
        }
    ],

identifier

This SHOULD be NHS number or local identifier (if NHS number is unavailable e.g. for non UK residents), though this MAY be omitted if no identifier for the family member is known. If a local identifier is used, an assigner SHALL be provided. The FamilyMemberHistory.identifier field SHALL match the identifier used for a RelatedPerson resource if the same person is being referenced.
   "identifier": {
      "system": "urn:oid:2.16.840.1.113883.2.1.3.2.4.18.24",
      "value": "FT-RWT13521",
      "assigner": {
        "identifier": {
          "system": "https://fhir.nhs.uk/Id/ods-organization-code",
          "value": "RAX"
        }
      }
    }
  }

status

Used to mark the completeness of a given family member's clinical history. If the history of a family member is expected but no history could be obtained, this element SHOULD be filled with 'health-unknown'.

Assertions regarding absence of relevant history SHOULD follow guidance within the HL7 FHIR R4 FamilyMemberHistory resource

"status": "completed",

patient

SHALL be present. Reference to the associated proband Patient for which this family history is being obtained. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS
"subject": {
        "reference": "Patient/Patient-MeirLieberman-Example",
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9449307873"
        }
    }

relationship

SHALL be present. Relationship between the person the FamilyMemberHistory references and the proband Patient. Clinical histories for each family member are expected to be recorded in separate FamilyMemberHistory resources. If multiple resources are required, both FamilyMemberHistory and related clinical artifacts such as Condition/Observation resources, these MAY be contained within a List resource to improve readability.

NOTE: The GA4GH Pedigree standard uses the Kinship ontology which has a different set of relationship types to the currently bound HL7 relationships. Alignment of the 2 systems is currently being investigated.

"relationship": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "PRN",
                "display": "parent"
            }
        ]
    }