Primary Care Data Standard

This version is in draft and is currently being updated to provide information about the Primary Care Data Standard.

Profile: CareConnect-FamilyMemberHistory

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
contained0..*Resource
recorderC0..1Extension(Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1))
id0..1string
extensionC0..0Extension
url1..1uriFixed Value
valueReference0..1Reference(Encounter)
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(CareConnect-Organization-1)
definitionΣ C0..*Reference(PlanDefinition | Questionnaire)
statusΣ ?!1..1codeBinding
notDoneΣ ?!0..1boolean
notDoneReasonΣ C0..1CodeableConcept
patientΣ C1..1Reference(CareConnect-Patient-1)
dateΣ0..1dateTime
nameΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
snomedCTDescriptionIDC0..1Extension(Complex)
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
genderΣ0..1codeBinding
bornDatedate
bornPeriodPeriod
bornStringstring
ageAgeAge
ageRangeRange
ageStringstring
estimatedAgeΣ ?! C0..1boolean
deceasedAgeAge
deceasedBooleanboolean
deceasedDatedate
deceasedRangeRange
deceasedStringstring
reasonCodeΣ0..*CodeableConcept
reasonReferenceΣ C0..*Reference(QuestionnaireResponse | CareConnect-AllergyIntolerance-1 | CareConnect-Condition-1 | CareConnect-Observation-1)
id0..1string
extensionC0..*Extension
authorReferenceReference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)
authorStringstring
timeΣ0..1dateTime
text1..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
id0..1string
extensionC0..*Extension
id0..1string
snomedCTDescriptionIDC0..1Extension(Complex)
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
snomedCTDescriptionIDC0..1Extension(Complex)
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
onsetAgeAge
onsetPeriodPeriod
onsetRangeRange
onsetStringstring
id0..1string
extensionC0..*Extension
authorReferenceReference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)
authorStringstring
timeΣ0..1dateTime
text1..1string
FamilyMemberHistoryC
ShortInformation about patient's relatives, relevant for patient
Definition

Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.

Cardinality0..*
Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
    contained.text.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
    contained.where(('#'+id in %resource.descendants().reference).not()).empty()
  • fhs-2: Can only have estimatedAge if age[x] is present
    age.exists() or estimatedAge.empty()
  • fhs-3: Not Done Reason can only be specified if NotDone is "true"
    notDone or notDoneReason.exists().not()
  • fhs-1: Can have age[x] or born[x], but not both
    age.empty() or born.empty()
Mappings
  • rim: Entity. Role, or Act
  • v2: Not in scope for v2
  • rim: Observation[classCode=OBS, moodCode=EVN]
  • w5: clinical.general
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() | (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 may 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() | (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.

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

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() | (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.

Common Languages (extensible)

Binding extensions
maxValueSetAll Languages
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() | (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.textC
ShortText summary of the resource, for human interpretation
Definition

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

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 in formation is added later.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, dom-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() | (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.

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

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

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() | (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:recorderC
ShortWho recorded the event
Definition

Who recorded the event.

Cardinality0..1
TypeExtension(Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1))
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() | (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:encounterC
ShortAssociated Encounter
Definition

This encounter occurs within the scope of the referenced encounter.

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() | (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:encounter.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.extension:encounter.extensionC
ShortAdditional Content defined by implementations
Definition

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

Cardinality0..0
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() | (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:encounter.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.

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() | (children().count() > id.count())
Fixed Value
http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.extension:encounter.valueReference:valueReference
ShortValue of extension
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality0..1
TypeReference(Encounter)
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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
FamilyMemberHistory.modifierExtension?! C
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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Cardinality0..*
TypeExtension
ModifierTrue
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() | (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 records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

Cardinality0..*
TypeIdentifier
SummaryTrue
Requirements

Need to allow connection to a wider workflow.

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() | (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 - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. 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
  • rim: id
  • w5: id
FamilyMemberHistory.identifier.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.identifier.extensionC
ShortAdditional Content defined by implementations
Definition

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

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() | (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.useΣ ?!
Shortusual | official | temp | secondary (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
FamilyMemberHistory.identifier.typeΣ
ShortDescription of identifier
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality0..1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)

SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
FamilyMemberHistory.identifier.systemΣ
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality1..1
Typeuri
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_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() | (children().count() > id.count())
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
FamilyMemberHistory.identifier.valueΣ
ShortThe value that is unique
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality1..1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

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() | (children().count() > id.count())
ExamplesGeneral
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
FamilyMemberHistory.identifier.periodΣ C
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Comments

This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.

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() | (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.empty() or end.empty() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
FamilyMemberHistory.identifier.assignerΣ C
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(CareConnect-Organization-1)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

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() | (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)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
FamilyMemberHistory.definitionΣ C
ShortInstantiates protocol or definition
Definition

A protocol or questionnaire that was adhered to in whole or in part by this event.

Cardinality0..*
TypeReference(PlanDefinition | Questionnaire)
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() | (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)
  • rim: .outboundRelationship[typeCode=DEFN].target
FamilyMemberHistory.statusΣ ?!
Shortpartial | completed | entered-in-error | health-unknown
Definition

A code specifying the status of the record of the family history of a specific family member.

Cardinality1..1
Typecode
Binding

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

FamilyHistoryStatus (required)

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: status
FamilyMemberHistory.notDoneΣ ?!
ShortThe taking of a family member's history did not occur
Definition

If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.

Cardinality0..1
Typeboolean
ModifierTrue
SummaryTrue
Requirements

Creating a FamilyMemberHistory where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task.

Comments

This element is labeled as a modifier because it marks the family member history as a family member history that did not occur. The more attributes are populated, the more constrained the negated statement is. This notDone element is being evaluated and will likely be removed in a subsequent release.

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() | (children().count() > id.count())
Default value
false
Mappings
  • rim: n/a
  • rim: .actionNegationInd
FamilyMemberHistory.notDoneReasonΣ C
Shortsubject-unknown | withheld | unable-to-obtain | deferred
Definition

Describes why the family member's history is absent.

Cardinality0..1
TypeCodeableConcept
Binding

Codes describing the reason why a family member history was not done.

FamilyHistoryNotDoneReason (example)

SummaryTrue
Requirements

This is a separate element to allow it to have a distinct binding from reasonCode.

Comments

This notDoneReason element is being evaluated and will likely be replaced in a subsequent release (e.g. dataAbsentReason).

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, fhs-3
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() | (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Σ C
ShortPatient history is about
Definition

The person who this history concerns.

Cardinality1..1
TypeReference(CareConnect-Patient-1)
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() | (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)
  • rim: participation[typeCode=SBJ].role
  • w5: who.focus
FamilyMemberHistory.dateΣ
ShortWhen history was captured/updated
Definition

The date (and possibly time) when the family member history was taken.

Cardinality0..1
TypedateTime
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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: participation[typeCode=AUT].time
  • w5: when.recorded
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
SummaryTrue
Requirements

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

Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: name
FamilyMemberHistory.relationshipΣ
ShortRelationship to the subject
Definition

The type of relationship this person has to the patient (father, mother, brother etc.).

Cardinality1..1
TypeCodeableConcept
Binding

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

FamilyMember (example)

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: code
FamilyMemberHistory.relationship.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.relationship.extensionC
ShortAdditional Content defined by implementations
Definition

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

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() | (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.relationship.codingΣ
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Slicing

Unordered, Open, by system(Value)

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
FamilyMemberHistory.relationship.coding:snomedCTΣ
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..1
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
FamilyMemberHistory.relationship.coding:snomedCT.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.relationship.coding:snomedCT.extensionC
ShortAdditional Content defined by implementations
Definition

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

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() | (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.relationship.coding:snomedCT.extension:snomedCTDescriptionIDC
ShortThe SNOMED CT Description ID for the display
Definition

The SNOMED CT Description ID for the display.

Cardinality0..1
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() | (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.relationship.coding:snomedCT.systemΣ
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality1..1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

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() | (children().count() > id.count())
Fixed Value
http://snomed.info/sct
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
FamilyMemberHistory.relationship.coding:snomedCT.versionΣ
ShortVersion of the system - if relevant
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Cardinality0..1
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
FamilyMemberHistory.relationship.coding:snomedCT.codeΣ
ShortSymbol in syntax defined by the system
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality1..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
FamilyMemberHistory.relationship.coding:snomedCT.displayΣ
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality1..1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
FamilyMemberHistory.relationship.coding:snomedCT.userSelectedΣ
ShortIf this coding was chosen directly by the user
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
FamilyMemberHistory.relationship.textΣ
ShortPlain text representation of the concept
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality0..1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
FamilyMemberHistory.genderΣ
Shortmale | female | other | unknown
Definition

Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.

Cardinality0..1
Typecode
Binding

The gender of a person used for administrative purposes.

Administrative Gender (required)

SummaryTrue
Requirements

Not all relationship codes imply gender and the relative's gender can be relevant for risk assessments.

Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.born[x]C
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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)
FamilyMemberHistory.age[x]Σ C
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 natureal 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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code="age"].value
FamilyMemberHistory.estimatedAgeΣ ?! C
ShortAge is estimated?
Definition

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

Cardinality0..1
Typeboolean
ModifierTrue
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 tha 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() | (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() | (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.

SNOMED CT Clinical Findings (example)

SummaryTrue
Comments

Textual reasons can be caprued 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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .reasonCode
  • w5: why
FamilyMemberHistory.reasonReferenceΣ C
ShortWhy was family member history performed?
Definition

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

Cardinality0..*
TypeReference(QuestionnaireResponse | CareConnect-AllergyIntolerance-1 | CareConnect-Condition-1 | CareConnect-Observation-1)
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() | (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)
  • rim: .outboundRelationship[typeCode=RSON].target
  • w5: why
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() | (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
FamilyMemberHistory.note.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.note.extensionC
ShortAdditional Content defined by implementations
Definition

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

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() | (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.note.author[x]Σ
ShortIndividual responsible for the annotation
Definition

The individual responsible for making the annotation.

Cardinality0..1
TypeReference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | 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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Act.participant[typeCode=AUT].role
FamilyMemberHistory.note.timeΣ
ShortWhen the annotation was made
Definition

Indicates when this particular annotation was made.

Cardinality0..1
TypedateTime
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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Act.effectiveTime
FamilyMemberHistory.note.text
ShortThe annotation - text content
Definition

The text of the annotation.

Cardinality1..1
Typestring
Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Act.text
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
Comments

If none of the conditions listed have an outcome of "death" specified, that indicates that none of the specified conditions are known to have been the primary cause of death.

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() | (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
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.condition.extensionC
ShortAdditional Content defined by implementations
Definition

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

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() | (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Σ ?! C
ShortExtensions that cannot be ignored
Definition

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

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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() | (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/Diagnosis Codes (example)

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() | (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.code.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.condition.code.extensionC
ShortAdditional Content defined by implementations
Definition

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

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() | (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.codingΣ
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Slicing

Unordered, Open, by system(Value)

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
FamilyMemberHistory.condition.code.coding:snomedCTΣ
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..1
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
FamilyMemberHistory.condition.code.coding:snomedCT.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.condition.code.coding:snomedCT.extensionC
ShortAdditional Content defined by implementations
Definition

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

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() | (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.coding:snomedCT.extension:snomedCTDescriptionIDC
ShortThe SNOMED CT Description ID for the display
Definition

The SNOMED CT Description ID for the display.

Cardinality0..1
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() | (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.coding:snomedCT.systemΣ
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality1..1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

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() | (children().count() > id.count())
Fixed Value
http://snomed.info/sct
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
FamilyMemberHistory.condition.code.coding:snomedCT.versionΣ
ShortVersion of the system - if relevant
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Cardinality0..1
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
FamilyMemberHistory.condition.code.coding:snomedCT.codeΣ
ShortSymbol in syntax defined by the system
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality1..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
FamilyMemberHistory.condition.code.coding:snomedCT.displayΣ
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality1..1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
FamilyMemberHistory.condition.code.coding:snomedCT.userSelectedΣ
ShortIf this coding was chosen directly by the user
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
FamilyMemberHistory.condition.code.textΣ
ShortPlain text representation of the concept
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality0..1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
FamilyMemberHistory.condition.outcome
Shortdeceased | permanent disability | etc.
Definition

Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.

Cardinality0..1
TypeCodeableConcept
Binding

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

Condition Outcome Codes (example)

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() | (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.outcome.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.condition.outcome.extensionC
ShortAdditional Content defined by implementations
Definition

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

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() | (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.outcome.codingΣ
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Slicing

Unordered, Open, by system(Value)

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
FamilyMemberHistory.condition.outcome.coding:snomedCTΣ
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..1
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
FamilyMemberHistory.condition.outcome.coding:snomedCT.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.condition.outcome.coding:snomedCT.extensionC
ShortAdditional Content defined by implementations
Definition

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

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() | (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.outcome.coding:snomedCT.extension:snomedCTDescriptionIDC
ShortThe SNOMED CT Description ID for the display
Definition

The SNOMED CT Description ID for the display.

Cardinality0..1
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() | (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.outcome.coding:snomedCT.systemΣ
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality1..1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

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() | (children().count() > id.count())
Fixed Value
http://snomed.info/sct
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
FamilyMemberHistory.condition.outcome.coding:snomedCT.versionΣ
ShortVersion of the system - if relevant
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Cardinality0..1
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
FamilyMemberHistory.condition.outcome.coding:snomedCT.codeΣ
ShortSymbol in syntax defined by the system
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality1..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
FamilyMemberHistory.condition.outcome.coding:snomedCT.displayΣ
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality1..1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
FamilyMemberHistory.condition.outcome.coding:snomedCT.userSelectedΣ
ShortIf this coding was chosen directly by the user
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
FamilyMemberHistory.condition.outcome.textΣ
ShortPlain text representation of the concept
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality0..1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
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() | (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() | (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
FamilyMemberHistory.condition.note.id
Shortxml:id (or equivalent in JSON)
Definition

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

Cardinality0..1
Typestring
Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
FamilyMemberHistory.condition.note.extensionC
ShortAdditional Content defined by implementations
Definition

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

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() | (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.note.author[x]Σ
ShortIndividual responsible for the annotation
Definition

The individual responsible for making the annotation.

Cardinality0..1
TypeReference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | 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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Act.participant[typeCode=AUT].role
FamilyMemberHistory.condition.note.timeΣ
ShortWhen the annotation was made
Definition

Indicates when this particular annotation was made.

Cardinality0..1
TypedateTime
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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Act.effectiveTime
FamilyMemberHistory.condition.note.text
ShortThe annotation - text content
Definition

The text of the annotation.

Cardinality1..1
Typestring
Comments

Note that FHIR strings may 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() | (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Act.text
<StructureDefinition xmlns="http://hl7.org/fhir">
<lastUpdated value="2023-08-04T11:39:37.5568537+00:00" />
</meta>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="pc" />
</extension>
<url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-FamilyMemberHistory-1" />
<version value="1.0.0" />
<name value="CareConnect-FamilyMemberHistory-1" />
<status value="draft" />
<date value="2017-07-12T15:03:45.0156449+01:00" />
<publisher value="NHS Digital" />
<name value="Interoperability Team" />
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
</telecom>
</contact>
<description value="Significant health events and conditions for a person related to the patient relevant in the context of care for the patient." />
<purpose value="[NOT CURATED BY INTEROPEN see: http://www.interopen.org/careconnect-curation-methodology/] Initial development for the Digital Maternity programme" />
<copyright value="Copyright © 2016 HL7 UK\n\nLicensed 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\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless 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.\n\nHL7® FHIR® standard Copyright © 2011+ HL7\n\nThe HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at\n\nhttps://www.hl7.org/fhir/license.html" />
<fhirVersion value="3.0.2" />
<kind value="resource" />
<abstract value="false" />
<type value="FamilyMemberHistory" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory" />
<derivation value="constraint" />
<element id="FamilyMemberHistory.extension">
<path value="FamilyMemberHistory.extension" />
<type value="value" />
<path value="url" />
</discriminator>
<rules value="open" />
</slicing>
<min value="0" />
</element>
<element id="FamilyMemberHistory.extension:recorder">
<path value="FamilyMemberHistory.extension" />
<sliceName value="recorder" />
<min value="0" />
<max value="1" />
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-Recorder-1" />
</type>
</element>
<element id="FamilyMemberHistory.extension:encounter">
<path value="FamilyMemberHistory.extension" />
<sliceName value="encounter" />
<min value="0" />
<code value="Extension" />
<profile value="http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter" />
</type>
</element>
<element id="FamilyMemberHistory.extension:encounter.valueReference:valueReference">
<path value="FamilyMemberHistory.extension.valueReference" />
<sliceName value="valueReference" />
</element>
<element id="FamilyMemberHistory.identifier.system">
<path value="FamilyMemberHistory.identifier.system" />
<min value="1" />
</element>
<element id="FamilyMemberHistory.identifier.value">
<path value="FamilyMemberHistory.identifier.value" />
<min value="1" />
</element>
<element id="FamilyMemberHistory.identifier.assigner">
<path value="FamilyMemberHistory.identifier.assigner" />
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1" />
</type>
</element>
<element id="FamilyMemberHistory.patient">
<path value="FamilyMemberHistory.patient" />
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1" />
</type>
</element>
<element id="FamilyMemberHistory.relationship.coding">
<path value="FamilyMemberHistory.relationship.coding" />
<type value="value" />
<path value="system" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
</element>
<element id="FamilyMemberHistory.relationship.coding:snomedCT">
<path value="FamilyMemberHistory.relationship.coding" />
<sliceName value="snomedCT" />
<max value="1" />
</element>
<element id="FamilyMemberHistory.relationship.coding:snomedCT.extension">
<path value="FamilyMemberHistory.relationship.coding.extension" />
<type value="value" />
<path value="url" />
</discriminator>
<rules value="open" />
</slicing>
<min value="0" />
</element>
<element id="FamilyMemberHistory.relationship.coding:snomedCT.extension:snomedCTDescriptionID">
<path value="FamilyMemberHistory.relationship.coding.extension" />
<sliceName value="snomedCTDescriptionID" />
<min value="0" />
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</type>
</element>
<element id="FamilyMemberHistory.relationship.coding:snomedCT.system">
<path value="FamilyMemberHistory.relationship.coding.system" />
<min value="1" />
<fixedUri value="http://snomed.info/sct" />
</element>
<element id="FamilyMemberHistory.relationship.coding:snomedCT.code">
<path value="FamilyMemberHistory.relationship.coding.code" />
<min value="1" />
</element>
<element id="FamilyMemberHistory.relationship.coding:snomedCT.display">
<path value="FamilyMemberHistory.relationship.coding.display" />
<min value="1" />
</element>
<element id="FamilyMemberHistory.gender">
<path value="FamilyMemberHistory.gender" />
<strength value="required" />
<reference value="https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-AdministrativeGender-1" />
</valueSetReference>
</binding>
</element>
<element id="FamilyMemberHistory.reasonReference">
<path value="FamilyMemberHistory.reasonReference" />
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Observation-1" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Condition-1" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-AllergyIntolerance-1" />
</type>
</element>
<element id="FamilyMemberHistory.note.author[x]">
<path value="FamilyMemberHistory.note.author[x]" />
<code value="string" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-RelatedPerson-1" />
</type>
</element>
<element id="FamilyMemberHistory.condition.code.coding">
<path value="FamilyMemberHistory.condition.code.coding" />
<type value="value" />
<path value="system" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
</element>
<element id="FamilyMemberHistory.condition.code.coding:snomedCT">
<path value="FamilyMemberHistory.condition.code.coding" />
<sliceName value="snomedCT" />
<max value="1" />
</element>
<element id="FamilyMemberHistory.condition.code.coding:snomedCT.extension">
<path value="FamilyMemberHistory.condition.code.coding.extension" />
<type value="value" />
<path value="url" />
</discriminator>
<rules value="open" />
</slicing>
<min value="0" />
</element>
<element id="FamilyMemberHistory.condition.code.coding:snomedCT.extension:snomedCTDescriptionID">
<path value="FamilyMemberHistory.condition.code.coding.extension" />
<sliceName value="snomedCTDescriptionID" />
<min value="0" />
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</type>
</element>
<element id="FamilyMemberHistory.condition.code.coding:snomedCT.system">
<path value="FamilyMemberHistory.condition.code.coding.system" />
<min value="1" />
<fixedUri value="http://snomed.info/sct" />
</element>
<element id="FamilyMemberHistory.condition.code.coding:snomedCT.code">
<path value="FamilyMemberHistory.condition.code.coding.code" />
<min value="1" />
</element>
<element id="FamilyMemberHistory.condition.code.coding:snomedCT.display">
<path value="FamilyMemberHistory.condition.code.coding.display" />
<min value="1" />
</element>
<element id="FamilyMemberHistory.condition.outcome.coding">
<path value="FamilyMemberHistory.condition.outcome.coding" />
<type value="value" />
<path value="system" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
</element>
<element id="FamilyMemberHistory.condition.outcome.coding:snomedCT">
<path value="FamilyMemberHistory.condition.outcome.coding" />
<sliceName value="snomedCT" />
<max value="1" />
</element>
<element id="FamilyMemberHistory.condition.outcome.coding:snomedCT.extension">
<path value="FamilyMemberHistory.condition.outcome.coding.extension" />
<type value="value" />
<path value="url" />
</discriminator>
<rules value="open" />
</slicing>
<min value="0" />
</element>
<element id="FamilyMemberHistory.condition.outcome.coding:snomedCT.extension:snomedCTDescriptionID">
<path value="FamilyMemberHistory.condition.outcome.coding.extension" />
<sliceName value="snomedCTDescriptionID" />
<min value="0" />
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</type>
</element>
<element id="FamilyMemberHistory.condition.outcome.coding:snomedCT.system">
<path value="FamilyMemberHistory.condition.outcome.coding.system" />
<min value="1" />
<fixedUri value="http://snomed.info/sct" />
</element>
<element id="FamilyMemberHistory.condition.outcome.coding:snomedCT.code">
<path value="FamilyMemberHistory.condition.outcome.coding.code" />
<min value="1" />
</element>
<element id="FamilyMemberHistory.condition.outcome.coding:snomedCT.display">
<path value="FamilyMemberHistory.condition.outcome.coding.display" />
<min value="1" />
</element>
<element id="FamilyMemberHistory.condition.note.author[x]">
<path value="FamilyMemberHistory.condition.note.author[x]" />
<code value="string" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-RelatedPerson-1" />
</type>
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"meta": {
"lastUpdated": "2023-08-04T11:39:37.5568537+00:00"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pc"
}
],
"url": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-FamilyMemberHistory-1",
"version": "1.0.0",
"name": "CareConnect-FamilyMemberHistory-1",
"status": "draft",
"date": "2017-07-12T15:03:45.0156449+01:00",
"publisher": "NHS Digital",
"contact": [
{
"name": "Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work"
}
]
}
],
"description": "Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.",
"purpose": "[NOT CURATED BY INTEROPEN see: http://www.interopen.org/careconnect-curation-methodology/] Initial development for the Digital Maternity programme",
"copyright": "Copyright © 2016 HL7 UK\n\nLicensed 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\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless 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.\n\nHL7® FHIR® standard Copyright © 2011+ HL7\n\nThe HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at\n\nhttps://www.hl7.org/fhir/license.html",
"fhirVersion": "3.0.2",
"kind": "resource",
"abstract": false,
"type": "FamilyMemberHistory",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory",
"derivation": "constraint",
"element": [
{
"id": "FamilyMemberHistory.extension",
"path": "FamilyMemberHistory.extension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"rules": "open"
},
"min": 0
},
{
"id": "FamilyMemberHistory.extension:recorder",
"path": "FamilyMemberHistory.extension",
"sliceName": "recorder",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-Recorder-1"
}
]
},
{
"id": "FamilyMemberHistory.extension:encounter",
"path": "FamilyMemberHistory.extension",
"sliceName": "encounter",
"min": 0,
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter"
}
]
},
{
"id": "FamilyMemberHistory.extension:encounter.valueReference:valueReference",
"path": "FamilyMemberHistory.extension.valueReference",
"sliceName": "valueReference"
},
{
"id": "FamilyMemberHistory.identifier.system",
"path": "FamilyMemberHistory.identifier.system",
"min": 1
},
{
"id": "FamilyMemberHistory.identifier.value",
"path": "FamilyMemberHistory.identifier.value",
"min": 1
},
{
"id": "FamilyMemberHistory.identifier.assigner",
"path": "FamilyMemberHistory.identifier.assigner",
"type": [
{
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1"
}
]
},
{
"id": "FamilyMemberHistory.patient",
"path": "FamilyMemberHistory.patient",
"type": [
{
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1"
}
]
},
{
"id": "FamilyMemberHistory.relationship.coding",
"path": "FamilyMemberHistory.relationship.coding",
"slicing": {
{
"type": "value",
"path": "system"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "FamilyMemberHistory.relationship.coding:snomedCT",
"path": "FamilyMemberHistory.relationship.coding",
"sliceName": "snomedCT",
"max": "1"
},
{
"id": "FamilyMemberHistory.relationship.coding:snomedCT.extension",
"path": "FamilyMemberHistory.relationship.coding.extension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"rules": "open"
},
"min": 0
},
{
"id": "FamilyMemberHistory.relationship.coding:snomedCT.extension:snomedCTDescriptionID",
"path": "FamilyMemberHistory.relationship.coding.extension",
"sliceName": "snomedCTDescriptionID",
"min": 0,
"type": [
{
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
}
]
},
{
"id": "FamilyMemberHistory.relationship.coding:snomedCT.system",
"path": "FamilyMemberHistory.relationship.coding.system",
"min": 1,
"fixedUri": "http://snomed.info/sct"
},
{
"id": "FamilyMemberHistory.relationship.coding:snomedCT.code",
"path": "FamilyMemberHistory.relationship.coding.code",
"min": 1
},
{
"id": "FamilyMemberHistory.relationship.coding:snomedCT.display",
"path": "FamilyMemberHistory.relationship.coding.display",
"min": 1
},
{
"id": "FamilyMemberHistory.gender",
"path": "FamilyMemberHistory.gender",
"binding": {
"strength": "required",
"reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-AdministrativeGender-1"
}
}
},
{
"id": "FamilyMemberHistory.reasonReference",
"path": "FamilyMemberHistory.reasonReference",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"
},
{
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Observation-1"
},
{
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Condition-1"
},
{
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-AllergyIntolerance-1"
}
]
},
{
"id": "FamilyMemberHistory.note.author[x]",
"path": "FamilyMemberHistory.note.author[x]",
"type": [
{
"code": "string"
},
{
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1"
},
{
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1"
},
{
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-RelatedPerson-1"
}
]
},
{
"id": "FamilyMemberHistory.condition.code.coding",
"path": "FamilyMemberHistory.condition.code.coding",
"slicing": {
{
"type": "value",
"path": "system"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "FamilyMemberHistory.condition.code.coding:snomedCT",
"path": "FamilyMemberHistory.condition.code.coding",
"sliceName": "snomedCT",
"max": "1"
},
{
"id": "FamilyMemberHistory.condition.code.coding:snomedCT.extension",
"path": "FamilyMemberHistory.condition.code.coding.extension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"rules": "open"
},
"min": 0
},
{
"id": "FamilyMemberHistory.condition.code.coding:snomedCT.extension:snomedCTDescriptionID",
"path": "FamilyMemberHistory.condition.code.coding.extension",
"sliceName": "snomedCTDescriptionID",
"min": 0,
"type": [
{
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
}
]
},
{
"id": "FamilyMemberHistory.condition.code.coding:snomedCT.system",
"path": "FamilyMemberHistory.condition.code.coding.system",
"min": 1,
"fixedUri": "http://snomed.info/sct"
},
{
"id": "FamilyMemberHistory.condition.code.coding:snomedCT.code",
"path": "FamilyMemberHistory.condition.code.coding.code",
"min": 1
},
{
"id": "FamilyMemberHistory.condition.code.coding:snomedCT.display",
"path": "FamilyMemberHistory.condition.code.coding.display",
"min": 1
},
{
"id": "FamilyMemberHistory.condition.outcome.coding",
"path": "FamilyMemberHistory.condition.outcome.coding",
"slicing": {
{
"type": "value",
"path": "system"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "FamilyMemberHistory.condition.outcome.coding:snomedCT",
"path": "FamilyMemberHistory.condition.outcome.coding",
"sliceName": "snomedCT",
"max": "1"
},
{
"id": "FamilyMemberHistory.condition.outcome.coding:snomedCT.extension",
"path": "FamilyMemberHistory.condition.outcome.coding.extension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"rules": "open"
},
"min": 0
},
{
"id": "FamilyMemberHistory.condition.outcome.coding:snomedCT.extension:snomedCTDescriptionID",
"path": "FamilyMemberHistory.condition.outcome.coding.extension",
"sliceName": "snomedCTDescriptionID",
"min": 0,
"type": [
{
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
}
]
},
{
"id": "FamilyMemberHistory.condition.outcome.coding:snomedCT.system",
"path": "FamilyMemberHistory.condition.outcome.coding.system",
"min": 1,
"fixedUri": "http://snomed.info/sct"
},
{
"id": "FamilyMemberHistory.condition.outcome.coding:snomedCT.code",
"path": "FamilyMemberHistory.condition.outcome.coding.code",
"min": 1
},
{
"id": "FamilyMemberHistory.condition.outcome.coding:snomedCT.display",
"path": "FamilyMemberHistory.condition.outcome.coding.display",
"min": 1
},
{
"id": "FamilyMemberHistory.condition.note.author[x]",
"path": "FamilyMemberHistory.condition.note.author[x]",
"type": [
{
"code": "string"
},
{
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1"
},
{
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1"
},
{
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-RelatedPerson-1"
}
]
}
]
}
}


Data model element usage

Element Use CareConnect (STU3) UK Core (R4)
extension(recorder)
extension(encounter)
identifier
definition
status
notDone
notDoneReason
patient
date
name
relationship
gender
born[x]
age[x]
estimatedAge
deceased[x]
reasonCode
reasonReference
note
condition

extension(recorder)

Usage Mandatory

Guidance The person who entered the record on the system. The table below outlines requester and recorder combinations for clarity.

Scenario Requester Recorder Prescibing clinician Fred is requesting new medication Fred Fred Prescibing clinician Fred is re-ordering previous medication he previously prescribed Fred Fred Prescibing clinician Jane is re-ordering previous medication, without any clinical changes, that Fred previously prescribed Fred Jane Prescibing clinician Jane is re-ordering previous medication that Fred previously prescribed, with clinical changes Jane Jane Nurse Rodger is ordering medication prescribed by Fred Fred Rodger Pharmacy technical Sally is re-ordering medication prescribed by Fred Fred Sally Example

<recorder>
    <identifier>
        <system value="https://fhir.hl7.org.uk/Id/gmc-number" />
        <value value="0054272" />
    </identifier>
 </recorder>


extension(encounter)

Usage

Optional

Guidance

Reference to the Encounter profile providing the context for the consultation (Date/Doctor/Place ….)

The Encounter reference is provided by all Lists in the structure rather than the top-level List(Consultation) only.

Example
<encounter>
    <reference value="encounter-12iaq" />
</encounter>


identifier

Usage

Required

Guidance

External Id(s) for this record

Example
<identifier>
    <system value="https://foo.bar/id/familymemberhistory" />
    <value value="fef26348-ccd1-440b-940e-ba1ec058cf21" />
</identifier>


definition

Usage

Mandatory

Guidance

A protocol or questionnaire that was adhered to in whole or in part by this event.

Reference ( PlanDefinition | Questionnaire )

Example
<patient>
    <reference value="questionnaire-9929ppp" />
</patient>


status

Usage

Optional

Guidance

The status of the family history

e.g. partial | completed | entered-in-error | health-unknown.

Example
    <status>
        <code value="completed" />
        <display value="completed " />
    </status>



notDone

Usage

Optional

Guidance

The taking of a family member's history did not occur - Boolean - True | False

Example
        <notDone value="True" />



notDoneReason

Usage

Optional

Guidance

The status of the family history

e.g. subject-unknown | withheld | unable-to-obtain | deferred. obtai

Example
    <status>
        <code value="withheld" />
        <display value="withheld " />
    </status>



patient

Usage

Mandatory

Guidance

A reference to the patient who the Family History relates to

Command 'pagelink' could not render: Page not found.

Example
<patient>
    <reference value="patient-9929alp" />
</patient>


date

Usage

Optional

Guidance

The date element should contain the date the family history was taken.


name

Usage

Optional

Guidance

The family member described

Example
<name>
    <family value="Black"/>
    <given value="Sarah"/>
    <prefix value="Mrs"/>
</name>


relationship

Usage

Mandatory

Guidance
  • The coded value for relationship to the person.
Example
<code>
    <coding>
        <system value="http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype" />
        <code value="SONFOST" />
        <display value="foster son" />
    </coding>
</code>


gender

Usage

Optional

Guidance

This element should be populated where available.

Example
<gender value="female"/>


born[x]

Usage

Required

Guidance

(approximate) date of birth.

The period attribute may be omitted where the effective / clinical date for the consultation on the source system is not recorded (for example, an unknown date and time).
Example
<bornPeriod>
    <start value="2022-10-28T13:38:00+00:00" />
    <end value="2024-10-28T13:38:00+00:00" />
</bornPeriod>
<bornDate value="2024-10-28T13:38:00+00:00" />
<bornString value="28th October 22/23/24?" />


age[x]

Usage

Required

Guidance

(approximate) age

The period attribute may be omitted where the effective / clinical date for the consultation on the source system is not recorded (for example, an unknown date and time).
Example
<age value="88" />
<Range>
    <low value="84" />
    <high value="92" />
</Range>

<String value="Suspected to be 88" />


estimatedAge

Usage

Optional

Guidance

Age is estimate ? - Boolean - True | False

Example
        <estimatedAge value="True" />



deceased[x]

Usage

Optional

Guidance

Patient is deceased - Boolean - True | False

Example
         <deceasedBoolean value="false"/> 



reasonCode

Usage

Optional

Guidance

The reasonCode describes why the family member history occurred in coded or textual form.

Example
<reasonCode>
    <coding>
        <system value="http://snomed.info/sct" />
        <code value="195967001" />
        <display value="Asthma (disorder)" />
    </coding>
</reasonCode>


reasonReference

Usage

Optional

Guidance
Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse)	
Example
<reasonReference>
    <reference value="condition--00f39ds" />
</reasonReference>


note

Usage

Required

Guidance

Any notes relating to the specified specimen.

Example
<note>
    <author>
        <reference value="practitioner-948392" />
    </author>
    <time value="2022-10-13T16:59:00Z" />
    <text>
        Free text... R4 of the FHIR standard supports GitHub Flavoured Markdown (GFM).
    </text>
</note>

condition

Usage

Optional

Guidance

The date element should contain the date the family history was taken.


Example

  <condition> 
    <code> 
      <coding> 
        <system value="http://snomed.info/sct"/> 
        <code value="22298006"/> 
        <display value="Myocardial Infarction"/> 
      </coding> 
      <text value="Heart Attack"/> 
    </code> 
    <contributedToDeath value="true"/> 
    <onsetAge> 
      <value value="74"/> 
      <unit value="yr"/> 
      <system value="http://unitsofmeasure.org"/> 
      <code value="a"/> 
    </onsetAge>
    ```

---

back to top