INTEROPen CareConnect Base STU3 Implementation Guide
3.0.0 - CI Build

INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions

StructureDefinition: CareConnect-FamilyMemberHistory-1 - Detailed Descriptions

Definitions for the CareConnect-FamilyMemberHistory-1 Profile.

1. FamilyMemberHistory
Definition

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

Control0..*
InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.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())
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())
fhs-1: Can have age[x] or born[x], but not both (: age.empty() or born.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())
2. FamilyMemberHistory.id
Definition

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

Control0..1
Typeid
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.

3. FamilyMemberHistory.meta
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.

Control0..1
TypeMeta
4. FamilyMemberHistory.implicitRules
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.

Control0..1
Typeuri
Is Modifiertrue
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.

5. FamilyMemberHistory.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Max Binding: All Languages
Typecode
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).

6. FamilyMemberHistory.text
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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, 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.

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

Control0..*
TypeResource
Alternate Namesinline 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.

8. FamilyMemberHistory.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on FamilyMemberHistory.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. FamilyMemberHistory.extension:recorder
SliceNamerecorder
Definition

Who recorded the event.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-Recorder-1) (Extension Type: Reference)
InvariantsDefined on this element
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())
10. FamilyMemberHistory.extension:encounter
SliceNameencounter
Definition

This encounter occurs within the scope of the referenced encounter.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(associatedEncounter) (Extension Type: Reference(Encounter))
InvariantsDefined on this element
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())
11. FamilyMemberHistory.modifierExtension
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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

12. FamilyMemberHistory.identifier
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).

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Need to allow connection to a wider workflow.

13. FamilyMemberHistory.identifier.id
Definition

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

Control0..1
Typestring
14. FamilyMemberHistory.identifier.extension
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

SlicingThis element introduces a set of slices on FamilyMemberHistory.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
15. FamilyMemberHistory.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
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.

16. FamilyMemberHistory.identifier.type
Definition

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

Control0..1
BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept
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.

17. FamilyMemberHistory.identifier.system
Definition

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

Control1..1
Typeuri
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.

Example
General:http://www.acme.com/identifiers/patient
18. FamilyMemberHistory.identifier.value
Definition

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

Control1..1
Typestring
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.

Example
General:123456
19. FamilyMemberHistory.identifier.period
Definition

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

Control0..1
TypePeriod
20. FamilyMemberHistory.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(CareConnect-Organization-1)
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.

21. FamilyMemberHistory.definition
Definition

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

Control0..*
TypeReference(PlanDefinition | Questionnaire)
22. FamilyMemberHistory.status
Definition

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

Control1..1
BindingA code that identifies the status of the family history record.
The codes SHALL be taken from FamilyHistoryStatus
Typecode
Is Modifiertrue
Comments

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

23. FamilyMemberHistory.notDone
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.

Control0..1
Typeboolean
Is Modifiertrue
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.

Default Valuefalse
24. FamilyMemberHistory.notDoneReason
Definition

Describes why the family member's history is absent.

Control0..1 This element is affected by the following invariants: fhs-3
BindingCodes describing the reason why a family member history was not done.
For example codes, see FamilyHistoryNotDoneReason
TypeCodeableConcept
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).

25. FamilyMemberHistory.patient
Definition

The person who this history concerns.

Control1..1
TypeReference(CareConnect-Patient-1)
Alternate NamesProband
26. FamilyMemberHistory.date
Definition

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

Control0..1
TypedateTime
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.

27. FamilyMemberHistory.name
Definition

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

Control0..1
Typestring
Requirements

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

28. FamilyMemberHistory.relationship
Definition

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

Control1..1
BindingThe nature of the relationship between the patient and the related person being described in the family member history.
For example codes, see FamilyMember
TypeCodeableConcept
29. FamilyMemberHistory.relationship.id
Definition

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

Control0..1
Typestring
30. FamilyMemberHistory.relationship.extension
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

SlicingThis element introduces a set of slices on FamilyMemberHistory.relationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
31. FamilyMemberHistory.relationship.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
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.

SlicingThis element introduces a set of slices on FamilyMemberHistory.relationship.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
32. FamilyMemberHistory.relationship.coding:snomedCT
SliceNamesnomedCT
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
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.

33. FamilyMemberHistory.relationship.coding:snomedCT.id
Definition

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

Control0..1
Typestring
34. FamilyMemberHistory.relationship.coding:snomedCT.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on FamilyMemberHistory.relationship.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
35. FamilyMemberHistory.relationship.coding:snomedCT.extension:snomedCTDescriptionID
SliceNamesnomedCTDescriptionID
Definition

The SNOMED CT Description ID for the display.

Control0..*
TypeExtension(Extension-coding-sctdescid) (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing)
36. FamilyMemberHistory.relationship.coding:snomedCT.system
Definition

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

Control1..1
Typeuri
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.

Fixed Valuehttp://snomed.info/sct
37. FamilyMemberHistory.relationship.coding:snomedCT.version
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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
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.

38. FamilyMemberHistory.relationship.coding:snomedCT.code
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).

Control1..1
Typecode
Requirements

Need to refer to a particular code in the system.

39. FamilyMemberHistory.relationship.coding:snomedCT.display
Definition

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

Control1..1
Typestring
Requirements

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

40. FamilyMemberHistory.relationship.coding:snomedCT.userSelected
Definition

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

Control0..1
Typeboolean
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.

41. FamilyMemberHistory.relationship.text
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.

Control0..1
Typestring
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.

42. FamilyMemberHistory.gender
Definition

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

Control0..1
BindingThe codes SHALL be taken from Administrative Gender
Typecode
Requirements

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

43. FamilyMemberHistory.born[x]
Definition

The actual or approximate date of birth of the relative.

Control0..1 This element is affected by the following invariants: fhs-1
TypeChoice of: Period, date, string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Allows calculation of the relative's age.

44. FamilyMemberHistory.age[x]
Definition

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

Control0..1 This element is affected by the following invariants: fhs-1
TypeChoice of: Age, Range, string
[x] NoteSee Choice of Data Types for further information about how to use [x]
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.

45. FamilyMemberHistory.estimatedAge
Definition

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

Control0..1 This element is affected by the following invariants: fhs-2
Typeboolean
Is Modifiertrue
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 if MissingIt is unknown whether the age is an estimate or not
46. FamilyMemberHistory.deceased[x]
Definition

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Control0..1
TypeChoice of: boolean, Age, Range, date, string
[x] NoteSee Choice of Data Types for further information about how to use [x]
47. FamilyMemberHistory.reasonCode
Definition

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

Control0..*
BindingCodes indicating why the family member history was done.
For example codes, see SNOMED CT Clinical Findings
TypeCodeableConcept
Comments

Textual reasons can be caprued using reasonCode.text.

48. FamilyMemberHistory.reasonReference
Definition

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

Control0..*
TypeReference(QuestionnaireResponse | CareConnect-Observation-1 | CareConnect-Condition-1 | CareConnect-AllergyIntolerance-1)
49. FamilyMemberHistory.note
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.

Control0..*
TypeAnnotation
50. FamilyMemberHistory.note.id
Definition

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

Control0..1
Typestring
51. FamilyMemberHistory.note.extension
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

SlicingThis element introduces a set of slices on FamilyMemberHistory.note.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
52. FamilyMemberHistory.note.author[x]
Definition

The individual responsible for making the annotation.

Control0..1
TypeChoice of: string, Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)
[x] NoteSee Choice of Data Types for further information about how to use [x]
53. FamilyMemberHistory.note.time
Definition

Indicates when this particular annotation was made.

Control0..1
TypedateTime
54. FamilyMemberHistory.note.text
Definition

The text of the annotation.

Control1..1
Typestring
55. FamilyMemberHistory.condition
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.

Control0..*
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
56. FamilyMemberHistory.condition.id
Definition

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

Control0..1
Typestring
57. FamilyMemberHistory.condition.extension
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

58. FamilyMemberHistory.condition.modifierExtension
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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

59. FamilyMemberHistory.condition.code
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.

Control1..1
BindingIdentification of the Condition or diagnosis.
For example codes, see Condition/Problem/Diagnosis Codes
TypeCodeableConcept
60. FamilyMemberHistory.condition.code.id
Definition

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

Control0..1
Typestring
61. FamilyMemberHistory.condition.code.extension
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

SlicingThis element introduces a set of slices on FamilyMemberHistory.condition.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
62. FamilyMemberHistory.condition.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
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.

SlicingThis element introduces a set of slices on FamilyMemberHistory.condition.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
63. FamilyMemberHistory.condition.code.coding:snomedCT
SliceNamesnomedCT
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
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.

64. FamilyMemberHistory.condition.code.coding:snomedCT.id
Definition

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

Control0..1
Typestring
65. FamilyMemberHistory.condition.code.coding:snomedCT.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on FamilyMemberHistory.condition.code.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
66. FamilyMemberHistory.condition.code.coding:snomedCT.extension:snomedCTDescriptionID
SliceNamesnomedCTDescriptionID
Definition

The SNOMED CT Description ID for the display.

Control0..*
TypeExtension(Extension-coding-sctdescid) (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing)
67. FamilyMemberHistory.condition.code.coding:snomedCT.system
Definition

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

Control1..1
Typeuri
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.

Fixed Valuehttp://snomed.info/sct
68. FamilyMemberHistory.condition.code.coding:snomedCT.version
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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
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.

69. FamilyMemberHistory.condition.code.coding:snomedCT.code
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).

Control1..1
Typecode
Requirements

Need to refer to a particular code in the system.

70. FamilyMemberHistory.condition.code.coding:snomedCT.display
Definition

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

Control1..1
Typestring
Requirements

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

71. FamilyMemberHistory.condition.code.coding:snomedCT.userSelected
Definition

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

Control0..1
Typeboolean
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.

72. FamilyMemberHistory.condition.code.text
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.

Control0..1
Typestring
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.

73. FamilyMemberHistory.condition.outcome
Definition

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

Control0..1
BindingThe result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.
For example codes, see Condition Outcome Codes
TypeCodeableConcept
74. FamilyMemberHistory.condition.outcome.id
Definition

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

Control0..1
Typestring
75. FamilyMemberHistory.condition.outcome.extension
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

SlicingThis element introduces a set of slices on FamilyMemberHistory.condition.outcome.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
76. FamilyMemberHistory.condition.outcome.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
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.

SlicingThis element introduces a set of slices on FamilyMemberHistory.condition.outcome.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
77. FamilyMemberHistory.condition.outcome.coding:snomedCT
SliceNamesnomedCT
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
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.

78. FamilyMemberHistory.condition.outcome.coding:snomedCT.id
Definition

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

Control0..1
Typestring
79. FamilyMemberHistory.condition.outcome.coding:snomedCT.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on FamilyMemberHistory.condition.outcome.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
80. FamilyMemberHistory.condition.outcome.coding:snomedCT.extension:snomedCTDescriptionID
SliceNamesnomedCTDescriptionID
Definition

The SNOMED CT Description ID for the display.

Control0..*
TypeExtension(Extension-coding-sctdescid) (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing)
81. FamilyMemberHistory.condition.outcome.coding:snomedCT.system
Definition

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

Control1..1
Typeuri
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.

Fixed Valuehttp://snomed.info/sct
82. FamilyMemberHistory.condition.outcome.coding:snomedCT.version
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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
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.

83. FamilyMemberHistory.condition.outcome.coding:snomedCT.code
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).

Control1..1
Typecode
Requirements

Need to refer to a particular code in the system.

84. FamilyMemberHistory.condition.outcome.coding:snomedCT.display
Definition

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

Control1..1
Typestring
Requirements

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

85. FamilyMemberHistory.condition.outcome.coding:snomedCT.userSelected
Definition

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

Control0..1
Typeboolean
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.

86. FamilyMemberHistory.condition.outcome.text
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.

Control0..1
Typestring
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.

87. FamilyMemberHistory.condition.onset[x]
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.

Control0..1
TypeChoice of: Age, Range, Period, string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

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

88. FamilyMemberHistory.condition.note
Definition

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

Control0..*
TypeAnnotation
89. FamilyMemberHistory.condition.note.id
Definition

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

Control0..1
Typestring
90. FamilyMemberHistory.condition.note.extension
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

SlicingThis element introduces a set of slices on FamilyMemberHistory.condition.note.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
91. FamilyMemberHistory.condition.note.author[x]
Definition

The individual responsible for making the annotation.

Control0..1
TypeChoice of: string, Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)
[x] NoteSee Choice of Data Types for further information about how to use [x]
92. FamilyMemberHistory.condition.note.time
Definition

Indicates when this particular annotation was made.

Control0..1
TypedateTime
93. FamilyMemberHistory.condition.note.text
Definition

The text of the annotation.

Control1..1
Typestring