NHDR Implementation Guide Release 1.0
0.1.0 - ci-build

NHDR Implementation Guide Release 1.0, published by NHDR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/UP-Manila-SILab/PhilHealth-NHDR-IG-Review/ and changes regularly. See the Directory of published versions

Resource Profile: PH FamilyMemberHistory

Official URL: https://nhdr.gov.ph/fhir/StructureDefinition/PH-FamilyMemberHistory Version: 0.1.0
Standards status: Draft Computable Name: PH_FamilyMemberHistory

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

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

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
Constraints: fhs-1, fhs-2
... status ?!Σ 1..1 code partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.
... patient Σ 1..1 Reference(PH Patient) Patient history is about
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
FamilyMemberHistory.​status Base required FamilyHistoryStatus 📍4.0.1 FHIR Std.
FamilyMemberHistory.​relationship Base required FamilyMember 📦3.0.0 THO v6.5

Constraints

Id Grade Path(s) Description Expression
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())
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()

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
... meta
.... Slices for extension Content/Rules for all slices
..... extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
..... extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
.... lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
... implicitRules 0..0
... language 0..0
... contained 0..0
... extension 0..0
... modifierExtension 0..0
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... dataAbsentReason 0..0
... patient 1..1 Reference(PH Patient) Patient history is about
... relationship 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (required)
... sex 0..0
... born[x] 0..0
... age[x] 0..0
... estimatedAge 0..0
... deceased[x] 0..0
... reasonCode 0..0
... reasonReference 0..0
... note 0..0
... condition
.... id 0..0
.... extension 0..0
.... modifierExtension 0..0
.... code 1..1 CodeableConcept Condition suffered by relation
Binding: ICD-10 Codes (required)
.... outcome 0..0
.... contributedToDeath 0..0
.... onset[x] 0..0

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
FamilyMemberHistory.​relationship Base required FamilyMember 📦3.0.0 THO v6.5
FamilyMemberHistory.​condition.code Base required ICD-10 Codes 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
Constraints: fhs-1, fhs-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
..... extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource was uploaded to the NHDR.
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... identifier Σ 0..* Identifier External Id(s) for this record
... patient Σ 1..1 Reference(PH Patient) Patient history is about
... date Σ 0..1 dateTime When history was recorded or last updated
... name Σ 0..1 string The family member described
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (required)
... condition 0..* BackboneElement Condition that the related person had
.... code 1..1 CodeableConcept Condition suffered by relation
Binding: ICD-10 Codes (required)
.... note 0..* Annotation Extra information about condition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
FamilyMemberHistory.​meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
FamilyMemberHistory.​meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
FamilyMemberHistory.​status Base required FamilyHistoryStatus 📍4.0.1 FHIR Std.
FamilyMemberHistory.​relationship Base required FamilyMember 📦3.0.0 THO v6.5
FamilyMemberHistory.​condition.code Base required ICD-10 Codes 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
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()

This structure is derived from FamilyMemberHistory

Summary

Prohibited: 23 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
Constraints: fhs-1, fhs-2
... status ?!Σ 1..1 code partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.
... patient Σ 1..1 Reference(PH Patient) Patient history is about
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
FamilyMemberHistory.​status Base required FamilyHistoryStatus 📍4.0.1 FHIR Std.
FamilyMemberHistory.​relationship Base required FamilyMember 📦3.0.0 THO v6.5

Constraints

Id Grade Path(s) Description Expression
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())
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()

Differential View

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
... meta
.... Slices for extension Content/Rules for all slices
..... extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
..... extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
.... lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
... implicitRules 0..0
... language 0..0
... contained 0..0
... extension 0..0
... modifierExtension 0..0
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... dataAbsentReason 0..0
... patient 1..1 Reference(PH Patient) Patient history is about
... relationship 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (required)
... sex 0..0
... born[x] 0..0
... age[x] 0..0
... estimatedAge 0..0
... deceased[x] 0..0
... reasonCode 0..0
... reasonReference 0..0
... note 0..0
... condition
.... id 0..0
.... extension 0..0
.... modifierExtension 0..0
.... code 1..1 CodeableConcept Condition suffered by relation
Binding: ICD-10 Codes (required)
.... outcome 0..0
.... contributedToDeath 0..0
.... onset[x] 0..0

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
FamilyMemberHistory.​relationship Base required FamilyMember 📦3.0.0 THO v6.5
FamilyMemberHistory.​condition.code Base required ICD-10 Codes 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
Constraints: fhs-1, fhs-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
..... extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource was uploaded to the NHDR.
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... identifier Σ 0..* Identifier External Id(s) for this record
... patient Σ 1..1 Reference(PH Patient) Patient history is about
... date Σ 0..1 dateTime When history was recorded or last updated
... name Σ 0..1 string The family member described
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (required)
... condition 0..* BackboneElement Condition that the related person had
.... code 1..1 CodeableConcept Condition suffered by relation
Binding: ICD-10 Codes (required)
.... note 0..* Annotation Extra information about condition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
FamilyMemberHistory.​meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
FamilyMemberHistory.​meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
FamilyMemberHistory.​status Base required FamilyHistoryStatus 📍4.0.1 FHIR Std.
FamilyMemberHistory.​relationship Base required FamilyMember 📦3.0.0 THO v6.5
FamilyMemberHistory.​condition.code Base required ICD-10 Codes 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
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()

This structure is derived from FamilyMemberHistory

Summary

Prohibited: 23 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron