FHIR Implementation Guide for ABDM
3.1.0 - active
FHIR Implementation Guide for ABDM - Local Development build (v3.1.0). See the Directory of published versions
| Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/FamilyMemberHistory | Version: 3.1.0 | |||
| Draft as of 2020-08-17 | Computable Name: FamilyMemberHistory | |||
This profile sets minimum expectations for the FamilyMemberHistory resource for searching and fetching significant health conditions of a person related to the patient in the context of care.
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from FamilyMemberHistory
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient | |
![]() ![]() | S | 1..1 | code | partial | completed | entered-in-error | health-unknown |
![]() ![]() | S | 1..1 | Reference(Patient) | Patient history is about |
![]() ![]() | S | 1..1 | CodeableConcept | Relationship to the subject |
![]() ![]() ![]() | S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() | 1..1 | string | Representation defined by the system | |
![]() ![]() ![]() | S | 0..1 | string | Plain text representation of the concept |
![]() ![]() | ||||
![]() ![]() ![]() | S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() | 1..1 | string | Representation defined by the system | |
![]() ![]() ![]() | S | 0..1 | string | Plain text representation of the concept |
![]() ![]() | 0..* | Reference(QuestionnaireResponse | Condition | Observation | AllergyIntolerance | DiagnosticReportLab | DiagnosticReportImaging | DocumentReference) | Why was family member history performed? | |
![]() ![]() | S | 1..* | BackboneElement | Condition that the related person had |
![]() ![]() ![]() | S | 1..1 | CodeableConcept | Condition suffered by relation |
![]() ![]() ![]() ![]() | S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() | S | 0..1 | string | Plain text representation of the concept |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | C | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | ?!SΣ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. |
![]() ![]() | SΣ | 1..1 | Reference(Patient) | Patient history is about |
![]() ![]() | SΣ | 1..1 | CodeableConcept | Relationship to the subject Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history. |
![]() ![]() ![]() | SΣ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() | Σ | 0..* | CodeableConcept | Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done. |
![]() ![]() ![]() | SΣ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() | Σ | 0..* | Reference(QuestionnaireResponse | Condition | Observation | AllergyIntolerance | DiagnosticReportLab | DiagnosticReportImaging | DocumentReference) | Why was family member history performed? |
![]() ![]() | S | 1..* | BackboneElement | Condition that the related person had |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() | S | 1..1 | CodeableConcept | Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis. |
![]() ![]() ![]() ![]() | SΣ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| FamilyMemberHistory.status | required | FamilyHistoryStatus |
| FamilyMemberHistory.relationship | example | FamilyMember |
| FamilyMemberHistory.reasonCode | example | SNOMEDCTClinicalFindings |
| FamilyMemberHistory.condition.code | example | Condition/Problem/DiagnosisCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | FamilyMemberHistory | 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-5 | error | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | FamilyMemberHistory | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| fhs-1 | error | FamilyMemberHistory | Can have age[x] or born[x], but not both : age.empty() or born.empty() | |
| fhs-2 | error | FamilyMemberHistory | Can only have estimatedAge if age[x] is present : age.exists() or estimatedAge.empty() |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | C | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient | ||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | Σ | 0..* | Identifier | External Id(s) for this record | ||||
![]() ![]() | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
![]() ![]() | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() | ?!SΣ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. | ||||
![]() ![]() | Σ | 0..1 | CodeableConcept | subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available. | ||||
![]() ![]() | SΣ | 1..1 | Reference(Patient) | Patient history is about | ||||
![]() ![]() | Σ | 0..1 | dateTime | When history was recorded or last updated | ||||
![]() ![]() | Σ | 0..1 | string | The family member described | ||||
![]() ![]() | SΣ | 1..1 | CodeableConcept | Relationship to the subject Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history. | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() | Σ | 0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration. | ||||
![]() ![]() | C | 0..1 | (approximate) date of birth | |||||
![]() ![]() ![]() | Period | |||||||
![]() ![]() ![]() | date | |||||||
![]() ![]() ![]() | string | |||||||
![]() ![]() | ΣC | 0..1 | (approximate) age | |||||
![]() ![]() ![]() | Age | |||||||
![]() ![]() ![]() | Range | |||||||
![]() ![]() ![]() | string | |||||||
![]() ![]() | ΣC | 0..1 | boolean | Age is estimated? | ||||
![]() ![]() | Σ | 0..1 | Dead? How old/when? | |||||
![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() | Age | |||||||
![]() ![]() ![]() | Range | |||||||
![]() ![]() ![]() | date | |||||||
![]() ![]() ![]() | string | |||||||
![]() ![]() | Σ | 0..* | CodeableConcept | Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done. | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() | Σ | 0..* | Reference(QuestionnaireResponse | Condition | Observation | AllergyIntolerance | DiagnosticReportLab | DiagnosticReportImaging | DocumentReference) | Why was family member history performed? | ||||
![]() ![]() | 0..* | Annotation | General note about related person | |||||
![]() ![]() | S | 1..* | BackboneElement | Condition that the related person had | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | S | 1..1 | CodeableConcept | Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis. | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. | |||||
![]() ![]() ![]() | 0..1 | boolean | Whether the condition contributed to the cause of death | |||||
![]() ![]() ![]() | 0..1 | When condition first manifested | ||||||
![]() ![]() ![]() ![]() | Age | |||||||
![]() ![]() ![]() ![]() | Range | |||||||
![]() ![]() ![]() ![]() | Period | |||||||
![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() | 0..* | Annotation | Extra information about condition | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| FamilyMemberHistory.language | preferred | CommonLanguages
| ||||
| FamilyMemberHistory.status | required | FamilyHistoryStatus | ||||
| FamilyMemberHistory.dataAbsentReason | example | FamilyHistoryAbsentReason | ||||
| FamilyMemberHistory.relationship | example | FamilyMember | ||||
| FamilyMemberHistory.sex | extensible | AdministrativeGender | ||||
| FamilyMemberHistory.reasonCode | example | SNOMEDCTClinicalFindings | ||||
| FamilyMemberHistory.condition.code | example | Condition/Problem/DiagnosisCodes | ||||
| FamilyMemberHistory.condition.outcome | example | ConditionOutcomeCodes |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from 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:
Differential View
This structure is derived from FamilyMemberHistory
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient | |
![]() ![]() | S | 1..1 | code | partial | completed | entered-in-error | health-unknown |
![]() ![]() | S | 1..1 | Reference(Patient) | Patient history is about |
![]() ![]() | S | 1..1 | CodeableConcept | Relationship to the subject |
![]() ![]() ![]() | S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() | 1..1 | string | Representation defined by the system | |
![]() ![]() ![]() | S | 0..1 | string | Plain text representation of the concept |
![]() ![]() | ||||
![]() ![]() ![]() | S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() | 1..1 | string | Representation defined by the system | |
![]() ![]() ![]() | S | 0..1 | string | Plain text representation of the concept |
![]() ![]() | 0..* | Reference(QuestionnaireResponse | Condition | Observation | AllergyIntolerance | DiagnosticReportLab | DiagnosticReportImaging | DocumentReference) | Why was family member history performed? | |
![]() ![]() | S | 1..* | BackboneElement | Condition that the related person had |
![]() ![]() ![]() | S | 1..1 | CodeableConcept | Condition suffered by relation |
![]() ![]() ![]() ![]() | S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() | S | 0..1 | string | Plain text representation of the concept |
Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | C | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | ?!SΣ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. |
![]() ![]() | SΣ | 1..1 | Reference(Patient) | Patient history is about |
![]() ![]() | SΣ | 1..1 | CodeableConcept | Relationship to the subject Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history. |
![]() ![]() ![]() | SΣ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() | Σ | 0..* | CodeableConcept | Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done. |
![]() ![]() ![]() | SΣ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() | Σ | 0..* | Reference(QuestionnaireResponse | Condition | Observation | AllergyIntolerance | DiagnosticReportLab | DiagnosticReportImaging | DocumentReference) | Why was family member history performed? |
![]() ![]() | S | 1..* | BackboneElement | Condition that the related person had |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() | S | 1..1 | CodeableConcept | Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis. |
![]() ![]() ![]() ![]() | SΣ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| FamilyMemberHistory.status | required | FamilyHistoryStatus |
| FamilyMemberHistory.relationship | example | FamilyMember |
| FamilyMemberHistory.reasonCode | example | SNOMEDCTClinicalFindings |
| FamilyMemberHistory.condition.code | example | Condition/Problem/DiagnosisCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | FamilyMemberHistory | 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-5 | error | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | FamilyMemberHistory | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| fhs-1 | error | FamilyMemberHistory | Can have age[x] or born[x], but not both : age.empty() or born.empty() | |
| fhs-2 | error | FamilyMemberHistory | Can only have estimatedAge if age[x] is present : age.exists() or estimatedAge.empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | C | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient | ||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | Σ | 0..* | Identifier | External Id(s) for this record | ||||
![]() ![]() | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
![]() ![]() | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() | ?!SΣ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. | ||||
![]() ![]() | Σ | 0..1 | CodeableConcept | subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available. | ||||
![]() ![]() | SΣ | 1..1 | Reference(Patient) | Patient history is about | ||||
![]() ![]() | Σ | 0..1 | dateTime | When history was recorded or last updated | ||||
![]() ![]() | Σ | 0..1 | string | The family member described | ||||
![]() ![]() | SΣ | 1..1 | CodeableConcept | Relationship to the subject Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history. | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() | Σ | 0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration. | ||||
![]() ![]() | C | 0..1 | (approximate) date of birth | |||||
![]() ![]() ![]() | Period | |||||||
![]() ![]() ![]() | date | |||||||
![]() ![]() ![]() | string | |||||||
![]() ![]() | ΣC | 0..1 | (approximate) age | |||||
![]() ![]() ![]() | Age | |||||||
![]() ![]() ![]() | Range | |||||||
![]() ![]() ![]() | string | |||||||
![]() ![]() | ΣC | 0..1 | boolean | Age is estimated? | ||||
![]() ![]() | Σ | 0..1 | Dead? How old/when? | |||||
![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() | Age | |||||||
![]() ![]() ![]() | Range | |||||||
![]() ![]() ![]() | date | |||||||
![]() ![]() ![]() | string | |||||||
![]() ![]() | Σ | 0..* | CodeableConcept | Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done. | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() | Σ | 0..* | Reference(QuestionnaireResponse | Condition | Observation | AllergyIntolerance | DiagnosticReportLab | DiagnosticReportImaging | DocumentReference) | Why was family member history performed? | ||||
![]() ![]() | 0..* | Annotation | General note about related person | |||||
![]() ![]() | S | 1..* | BackboneElement | Condition that the related person had | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | S | 1..1 | CodeableConcept | Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis. | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. | |||||
![]() ![]() ![]() | 0..1 | boolean | Whether the condition contributed to the cause of death | |||||
![]() ![]() ![]() | 0..1 | When condition first manifested | ||||||
![]() ![]() ![]() ![]() | Age | |||||||
![]() ![]() ![]() ![]() | Range | |||||||
![]() ![]() ![]() ![]() | Period | |||||||
![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() | 0..* | Annotation | Extra information about condition | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| FamilyMemberHistory.language | preferred | CommonLanguages
| ||||
| FamilyMemberHistory.status | required | FamilyHistoryStatus | ||||
| FamilyMemberHistory.dataAbsentReason | example | FamilyHistoryAbsentReason | ||||
| FamilyMemberHistory.relationship | example | FamilyMember | ||||
| FamilyMemberHistory.sex | extensible | AdministrativeGender | ||||
| FamilyMemberHistory.reasonCode | example | SNOMEDCTClinicalFindings | ||||
| FamilyMemberHistory.condition.code | example | Condition/Problem/DiagnosisCodes | ||||
| FamilyMemberHistory.condition.outcome | example | ConditionOutcomeCodes |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from 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:
Other representations of profile: CSV, Excel, Schematron