Smart Bear Implementation Guide
0.3.2 - ci-build

Smart Bear Implementation Guide - Local Development build (v0.3.2). See the Directory of published versions

Resource Profile: Family Hearing Loss Family Member History

Official URL: https://smart-bear.eu/fhir/StructureDefinition/FamilyHearingLossFamilyMemberHistory Version: 0.3.2
Active as of 2023-11-21 Computable Name: FamilyHearingLossFamilyMemberHistory

FamilyMemberHistory on family hearing loss

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... encounter S1..1Reference(Encounter)FamilyMemberHistory Encounter
URL: https://smart-bear.eu/fhir/StructureDefinition/FamilyMemberHistoryEncounter
.... valueReference 0..1Reference()Value of extension
... date 1..1dateTimeWhen history was recorded or last updated
... condition
.... code 1..1CodeableConceptCondition suffered by relation
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 439750006
...... display1..1stringRepresentation defined by the system
Fixed Value: Family history of hearing loss

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
FamilyMemberHistory.relationshiprequiredROLVS
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... encounter S1..1Reference(Encounter)FamilyMemberHistory Encounter
URL: https://smart-bear.eu/fhir/StructureDefinition/FamilyMemberHistoryEncounter
.... extension 0..0
.... url 1..1uri"https://smart-bear.eu/fhir/StructureDefinition/FamilyMemberHistoryEncounter"
.... Slices for value[x] 0..1Reference(Encounter)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference 0..1Reference()Value of extension
... status ?!Σ1..1codepartial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.

... patient Σ1..1Reference(Patient)Patient history is about
... date Σ1..1dateTimeWhen history was recorded or last updated
... relationship Σ1..1CodeableConceptRelationship to the subject
Binding: Role of Family Member History relationship Velue Set (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
FamilyMemberHistory.relationshiprequiredROLVS
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... encounter S1..1Reference(Encounter)FamilyMemberHistory Encounter
URL: https://smart-bear.eu/fhir/StructureDefinition/FamilyMemberHistoryEncounter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"https://smart-bear.eu/fhir/StructureDefinition/FamilyMemberHistoryEncounter"
.... Slices for value[x] 0..1Reference(Encounter)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference 0..1Reference()Value of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Id(s) for this record
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... status ?!Σ1..1codepartial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.

... dataAbsentReason Σ0..1CodeableConceptsubject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.

... patient Σ1..1Reference(Patient)Patient history is about
... date Σ1..1dateTimeWhen history was recorded or last updated
... name Σ0..1stringThe family member described
... relationship Σ1..1CodeableConceptRelationship to the subject
Binding: Role of Family Member History relationship Velue Set (required)
... sex Σ0..1CodeableConceptmale | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... born[x] C0..1(approximate) date of birth
.... bornPeriodPeriod
.... bornDatedate
.... bornStringstring
... age[x] ΣC0..1(approximate) age
.... ageAgeAge
.... ageRangeRange
.... ageStringstring
... estimatedAge ΣC0..1booleanAge is estimated?
... deceased[x] Σ0..1Dead? How old/when?
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceasedRangeRange
.... deceasedDatedate
.... deceasedStringstring
... reasonCode Σ0..*CodeableConceptWhy was family member history performed?
Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.


... reasonReference Σ0..*Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)Why was family member history performed?
... note 0..*AnnotationGeneral note about related person
... condition 0..*BackboneElementCondition that the related person had
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptCondition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.


Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 439750006
...... display1..1stringRepresentation defined by the system
Fixed Value: Family history of hearing loss
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... outcome 0..1CodeableConceptdeceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath 0..1booleanWhether the condition contributed to the cause of death
.... onset[x] 0..1When condition first manifested
..... onsetAgeAge
..... onsetRangeRange
..... onsetPeriodPeriod
..... onsetStringstring
.... note 0..*AnnotationExtra information about condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
FamilyMemberHistory.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
FamilyMemberHistory.dataAbsentReasonexampleFamilyHistoryAbsentReason
FamilyMemberHistory.relationshiprequiredROLVS
FamilyMemberHistory.sexextensibleAdministrativeGender
FamilyMemberHistory.reasonCodeexampleSNOMEDCTClinicalFindings
FamilyMemberHistory.condition.codeexamplePattern: SNOMED CT code 439750006("Family history of hearing loss")
FamilyMemberHistory.condition.outcomeexampleConditionOutcomeCodes

This structure is derived from FamilyMemberHistory

Summary

Mandatory: 3 elements
Must-Support: 1 element

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... encounter S1..1Reference(Encounter)FamilyMemberHistory Encounter
URL: https://smart-bear.eu/fhir/StructureDefinition/FamilyMemberHistoryEncounter
.... valueReference 0..1Reference()Value of extension
... date 1..1dateTimeWhen history was recorded or last updated
... condition
.... code 1..1CodeableConceptCondition suffered by relation
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 439750006
...... display1..1stringRepresentation defined by the system
Fixed Value: Family history of hearing loss

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
FamilyMemberHistory.relationshiprequiredROLVS

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... encounter S1..1Reference(Encounter)FamilyMemberHistory Encounter
URL: https://smart-bear.eu/fhir/StructureDefinition/FamilyMemberHistoryEncounter
.... extension 0..0
.... url 1..1uri"https://smart-bear.eu/fhir/StructureDefinition/FamilyMemberHistoryEncounter"
.... Slices for value[x] 0..1Reference(Encounter)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference 0..1Reference()Value of extension
... status ?!Σ1..1codepartial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.

... patient Σ1..1Reference(Patient)Patient history is about
... date Σ1..1dateTimeWhen history was recorded or last updated
... relationship Σ1..1CodeableConceptRelationship to the subject
Binding: Role of Family Member History relationship Velue Set (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
FamilyMemberHistory.relationshiprequiredROLVS

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... encounter S1..1Reference(Encounter)FamilyMemberHistory Encounter
URL: https://smart-bear.eu/fhir/StructureDefinition/FamilyMemberHistoryEncounter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"https://smart-bear.eu/fhir/StructureDefinition/FamilyMemberHistoryEncounter"
.... Slices for value[x] 0..1Reference(Encounter)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference 0..1Reference()Value of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Id(s) for this record
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... status ?!Σ1..1codepartial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.

... dataAbsentReason Σ0..1CodeableConceptsubject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.

... patient Σ1..1Reference(Patient)Patient history is about
... date Σ1..1dateTimeWhen history was recorded or last updated
... name Σ0..1stringThe family member described
... relationship Σ1..1CodeableConceptRelationship to the subject
Binding: Role of Family Member History relationship Velue Set (required)
... sex Σ0..1CodeableConceptmale | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... born[x] C0..1(approximate) date of birth
.... bornPeriodPeriod
.... bornDatedate
.... bornStringstring
... age[x] ΣC0..1(approximate) age
.... ageAgeAge
.... ageRangeRange
.... ageStringstring
... estimatedAge ΣC0..1booleanAge is estimated?
... deceased[x] Σ0..1Dead? How old/when?
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceasedRangeRange
.... deceasedDatedate
.... deceasedStringstring
... reasonCode Σ0..*CodeableConceptWhy was family member history performed?
Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.


... reasonReference Σ0..*Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)Why was family member history performed?
... note 0..*AnnotationGeneral note about related person
... condition 0..*BackboneElementCondition that the related person had
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptCondition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.


Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 439750006
...... display1..1stringRepresentation defined by the system
Fixed Value: Family history of hearing loss
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... outcome 0..1CodeableConceptdeceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath 0..1booleanWhether the condition contributed to the cause of death
.... onset[x] 0..1When condition first manifested
..... onsetAgeAge
..... onsetRangeRange
..... onsetPeriodPeriod
..... onsetStringstring
.... note 0..*AnnotationExtra information about condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
FamilyMemberHistory.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
FamilyMemberHistory.dataAbsentReasonexampleFamilyHistoryAbsentReason
FamilyMemberHistory.relationshiprequiredROLVS
FamilyMemberHistory.sexextensibleAdministrativeGender
FamilyMemberHistory.reasonCodeexampleSNOMEDCTClinicalFindings
FamilyMemberHistory.condition.codeexamplePattern: SNOMED CT code 439750006("Family history of hearing loss")
FamilyMemberHistory.condition.outcomeexampleConditionOutcomeCodes

This structure is derived from FamilyMemberHistory

Summary

Mandatory: 3 elements
Must-Support: 1 element

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron