FHIR Implementation Guide for NDHM CI Build v2.0
banner

NDHM (R4), Published and maintained by NRCeS for NHA.
This version is based on the NDHM Health Data Interchange Specifications 1.0 and updated periodically.

StructureDefinition-FamilyMemberHistory

This profile sets minimum expectations for the FamilyMemberHistory resource to searching for and fetching a Organization associated with a patient or provider. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Examples

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: https://nrces.in/ndhm/fhir/r4/StructureDefinition/FamilyMemberHistory

This profile builds on FamilyMemberHistory

Summary

Mandatory: 1 element (6 nested mandatory elements)
Must-Support: 11 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... status S1..1codepartial | completed | entered-in-error | health-unknown
... patient S1..1Reference(Patient)Patient history is about
... relationship S1..1CodeableConceptRelationship to the subject
.... coding S0..*CodingCode defined by a terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... text S0..1stringPlain text representation of the concept
... reasonCode
.... coding S0..*CodingCode defined by a terminology system
..... system 0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... text S0..1stringPlain text representation of the concept
... reasonReference 0..*Reference(QuestionnaireResponse | Condition | Observation | AllergyIntolerance | DiagnosticReportLab | DiagnosticReportImaging | DocumentReference)Why was family member history performed?
... condition S1..*BackboneElementCondition that the related person had
.... code S1..1CodeableConceptCondition suffered by relation
..... coding S0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
..... text S0..1stringPlain text representation of the concept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory I0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal Id(s) for this record
... instantiatesCanonical ΣI0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... status ?!SΣI1..1codepartial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required)
... dataAbsentReason ΣI0..1CodeableConceptsubject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryAbsentReason (example)
... patient SΣI1..1Reference(Patient)Patient history is about
... date ΣI0..1dateTimeWhen history was recorded or last updated
... name ΣI0..1stringThe family member described
... relationship SΣI1..1CodeableConceptRelationship to the subject
Binding: FamilyMember (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1uriIdentity of the terminology system
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI1..1codeSymbol in syntax defined by the system
..... display ΣI1..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text SΣI0..1stringPlain text representation of the concept
... sex ΣI0..1CodeableConceptmale | female | other | unknown
Binding: AdministrativeGender (extensible)
... born[x] I0..1(approximate) date of birth
.... bornPeriodPeriod
.... bornDatedate
.... bornStringstring
... age[x] ΣI0..1(approximate) age
.... ageAgeAge
.... ageRangeRange
.... ageStringstring
... estimatedAge ΣI0..1booleanAge is estimated?
... deceased[x] ΣI0..1Dead? How old/when?
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceasedRangeRange
.... deceasedDatedate
.... deceasedStringstring
... reasonCode ΣI0..*CodeableConceptWhy was family member history performed?
Binding: SNOMEDCTClinicalFindings (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI1..1codeSymbol in syntax defined by the system
..... display ΣI1..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text SΣI0..1stringPlain text representation of the concept
... reasonReference ΣI0..*Reference(QuestionnaireResponse | Condition | Observation | AllergyIntolerance | DiagnosticReportLab | DiagnosticReportImaging | DocumentReference)Why was family member history performed?
... note I0..*AnnotationGeneral note about related person
... condition SI1..*BackboneElementCondition that the related person had
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SI1..1CodeableConceptCondition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣI0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
...... display ΣI1..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text SΣI0..1stringPlain text representation of the concept
.... outcome I0..1CodeableConceptdeceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example)
.... contributedToDeath I0..1booleanWhether the condition contributed to the cause of death
.... onset[x] I0..1When condition first manifested
..... onsetAgeAge
..... onsetRangeRange
..... onsetPeriodPeriod
..... onsetStringstring
.... note I0..*AnnotationExtra information about condition

doco Documentation for this format

Summary

Mandatory: 1 element (6 nested mandatory elements)
Must-Support: 11 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... status S1..1codepartial | completed | entered-in-error | health-unknown
... patient S1..1Reference(Patient)Patient history is about
... relationship S1..1CodeableConceptRelationship to the subject
.... coding S0..*CodingCode defined by a terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... text S0..1stringPlain text representation of the concept
... reasonCode
.... coding S0..*CodingCode defined by a terminology system
..... system 0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... text S0..1stringPlain text representation of the concept
... reasonReference 0..*Reference(QuestionnaireResponse | Condition | Observation | AllergyIntolerance | DiagnosticReportLab | DiagnosticReportImaging | DocumentReference)Why was family member history performed?
... condition S1..*BackboneElementCondition that the related person had
.... code S1..1CodeableConceptCondition suffered by relation
..... coding S0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
..... text S0..1stringPlain text representation of the concept

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory I0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal Id(s) for this record
... instantiatesCanonical ΣI0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... status ?!SΣI1..1codepartial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required)
... dataAbsentReason ΣI0..1CodeableConceptsubject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryAbsentReason (example)
... patient SΣI1..1Reference(Patient)Patient history is about
... date ΣI0..1dateTimeWhen history was recorded or last updated
... name ΣI0..1stringThe family member described
... relationship SΣI1..1CodeableConceptRelationship to the subject
Binding: FamilyMember (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1uriIdentity of the terminology system
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI1..1codeSymbol in syntax defined by the system
..... display ΣI1..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text SΣI0..1stringPlain text representation of the concept
... sex ΣI0..1CodeableConceptmale | female | other | unknown
Binding: AdministrativeGender (extensible)
... born[x] I0..1(approximate) date of birth
.... bornPeriodPeriod
.... bornDatedate
.... bornStringstring
... age[x] ΣI0..1(approximate) age
.... ageAgeAge
.... ageRangeRange
.... ageStringstring
... estimatedAge ΣI0..1booleanAge is estimated?
... deceased[x] ΣI0..1Dead? How old/when?
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceasedRangeRange
.... deceasedDatedate
.... deceasedStringstring
... reasonCode ΣI0..*CodeableConceptWhy was family member history performed?
Binding: SNOMEDCTClinicalFindings (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI1..1codeSymbol in syntax defined by the system
..... display ΣI1..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text SΣI0..1stringPlain text representation of the concept
... reasonReference ΣI0..*Reference(QuestionnaireResponse | Condition | Observation | AllergyIntolerance | DiagnosticReportLab | DiagnosticReportImaging | DocumentReference)Why was family member history performed?
... note I0..*AnnotationGeneral note about related person
... condition SI1..*BackboneElementCondition that the related person had
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SI1..1CodeableConceptCondition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣI0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
...... display ΣI1..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text SΣI0..1stringPlain text representation of the concept
.... outcome I0..1CodeableConceptdeceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example)
.... contributedToDeath I0..1booleanWhether the condition contributed to the cause of death
.... onset[x] I0..1When condition first manifested
..... onsetAgeAge
..... onsetRangeRange
..... onsetPeriodPeriod
..... onsetStringstring
.... note I0..*AnnotationExtra information about condition

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron